IdentityEntity

List all entities

Retrieve all entities on your platform. Filtered results can be retrieved with extra parameters in the query (type, name, etc.).

get/entities

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/entities
  • Auth: HTTP basic

Query parameters

created.gtstring date-time

Return results where the created time is greater than this value.

created.gtestring date-time

Return results where the created time is greater than or equal to this value.

created.ltstring date-time

Return results where the created time is less than this value.

created.ltestring date-time

Return results where the created time is less than or equal to this value.

ending_beforestring

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

is_rootboolean

Return results matching the specified root status.

limitinteger

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

namestring

Return entities with this name.

querystring

Free-text search query to match against entity fields.

starting_afterstring

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

typestring

Return results with this entity type, either PERSON or BUSINESS.

verification_statusstring

Return results with this verification status.

Response

Successful response

has_moreboolean required

Whether there are more results available after this set.

Changes

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