Multi-entity: List connections

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Retrieves information about certain connections for a specified entity. You can specify the entity to retrieve in the Zuora-Entity-Ids request header.

You can retrieve:

  • Inbound connections
  • Outbound connections
  • Both inbound and outbound connections

User Access Permission

You can make the call as any entity user.

Request
query Parameters
page
integer >= 1
Default: 1

The index number of the page that you want to retrieve. This parameter is dependent on pageSize. You must set pageSize before specifying page. For example, if you set pageSize to 20 and page to 2, the 21st to 40th records are returned in the response.

pageSize
integer <= 300
Default: 30

The number of records returned per page in the response.

type
string

Specifies whether to retrieve inbound or outbound connections for an entity.

Possible values:

  • inbound: All the incoming connections to the entity.
  • outbound: All the outgoing connections from the entity.

If you do not specify this field in the request, both the inbound and outbound connections are returned.

Enum: "inbound" "outbound"
header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Responses
200
get/v1/entity-connections
Request samples 
Response samples 
application/json
{
  • "entityConnections": [
    ],
  • "success": true
}