Expanding responses

Expanding responses allows you to reduce API requests by including additional related information in a single response.

What are expandable properties?

The Mambo API's expand feature lets you retrieve additional properties of objects in your response:

• Properties that can be expanded are marked as Expandable in the API explorer.
• You can request multiple expanded properties in a single API call.
• Nested properties can be expanded using dot notation (e.g., parent.summary).

Examples of expanding responses

Basic expansion (single property)

Retrieve a user's point transactions with the parent object expanded:

Java

.NET

PHP

// Retrieve a single expandable property
UserGetPointTransactionsParams params = UserGetPointTransactionsParams.builder()
  .siteUrl( "acmeinc" )
  .uuid( "user_uuid" )
  .pointId( "point_id" )
  .expand( List.of( "parent" ) )
  .build();

client.users().points().getPointTransactions( params );

// Retrieve a single expandable property
UserGetPointTransactionsOptions options = new UserGetPointTransactionsOptions();
options.SiteUrl = "acmeinc";
options.Uuid = "user_uuid";
options.PointId = "point_id";
options.Expand = new List<string> { "parent" };

client.Users.Points.GetPointTransactions( options );

// Retrieve a single expandable property
$params = new UserGetPointTransactionsParams();
$params->expand( array( 'parent' ) );

$client->users()->getPointTransactions( 'acmeinc', 'user_uuid', 'point_id', $params );

Multiple properties expansion

Expand both the parent and source properties in a single request:

Java

.NET

PHP

// Retrieve multiple expandable properties
UserGetPointTransactionsParams params = UserGetPointTransactionsParams.builder()
  .siteUrl( "acmeinc" )
  .uuid( "user_uuid" )
  .pointId( "point_id" )
  .expand( List.of( "parent", "source" ) )
  .build();

client.users().points().getPointTransactions( params );

// Retrieve multiple expandable properties
UserGetPointTransactionsOptions options = new UserGetPointTransactionsOptions();
options.SiteUrl = "acmeinc";
options.Uuid = "user_uuid";
options.PointId = "point_id";
options.Expand = new List<string> { "parent", "source" };

client.Users.Points.GetPointTransactions( options );

// Retrieve multiple expandable properties
$params = new UserGetPointTransactionsParams();
$params->expand( array( 'parent', 'source' ) );

$client->users()->getPointTransactions( 'acmeinc', 'user_uuid', 'point_id', $params );

Nested properties expansion

Access deeper levels of related objects using dot notation:

Java

.NET

PHP

// Retrieve multi-level expandable property
UserGetPointTransactionsParams params = UserGetPointTransactionsParams.builder()
  .siteUrl( "acmeinc" )
  .uuid( "user_uuid" )
  .pointId( "point_id" )
  .expand( List.of( "parent.summary", "source" ) )
  .build();

client.users().points().getPointTransactions( params );

// Retrieve multi-level expandable property
UserGetPointTransactionsOptions options = new UserGetPointTransactionsOptions();
options.SiteUrl = "acmeinc";
options.Uuid = "user_uuid";
options.PointId = "point_id";
options.Expand = new List<string> { "parent.summary", "source" };

client.Users.Points.GetPointTransactions( options );

// Retrieve multi-level expandable property
$params = new UserGetPointTransactionsParams();
$params->expand( array( 'parent.summary', 'source' ) );

$client->users()->getPointTransactions( 'acmeinc', 'user_uuid', 'point_id', $params );

Performance considerations

While expansion reduces the number of API calls, expanding too many properties in a single request may increase response time. Consider expanding only the properties you need for your immediate use case.

---

Related topics

• API reference
• Points