IdentityEntity

List associated persons

List the associated persons for a business entity. Results are paginated newest-first; use limit (default 10, max 100) with the starting_after / ending_before person entity ID cursors to page through businesses with many associated persons.

get/entities/{entity_id}/associated-persons

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/entities/{entity_id}/associated-persons
  • Auth: HTTP basic

Path parameters

entity_idstring required

Query parameters

ending_beforestring

A cursor for use in pagination. ending_before is the person_entity_id of an associated person that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with enti_ZXhhbXBsZQo, your subsequent call can include ending_before=enti_ZXhhbXBsZQo in order to fetch the previous page of the list.

limitinteger

A limit on the number of objects to be returned, between 1 and 100. The default is 10.

starting_afterstring

A cursor for use in pagination. starting_after is the person_entity_id of an associated person that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with enti_ZXhhbXBsZQo, your subsequent call can include starting_after=enti_ZXhhbXBsZQo in order to fetch the next page of the list.

Response

Successful response

has_moreboolean required

Whether there are more results available after this set.

idstring required

The entity ID this list of associated persons belongs to.

Changes

No recorded changes to this operation across all 1 revision of this API.