CustomerRelationships

Search customer relationships

Search for one or more customer relationships.

get/v1/CustomerRelationships

Request

Query parameters

search.customer_relationship_idinteger[]

Query by customer relationship identifier.

search.customer_idinteger[]

Query by primary customer identifier.

search.related_customer_idinteger[]

Query by customer identifier that is related to a primary customer.

search.customer_relationship_type_idinteger[]

Query by customer relationship type identifier.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

No recorded changes to this operation across all 2 revisions of this API.