Entity

Search entities

GET
Search all entities with the given filters. If no filters are provided, all entities will be returned.

Query parameters

paymentMethodsbooleanOptional
If true, will include entity payment methods as part of the response
isCustomerbooleanOptional
If true, only entities with a direct relationship to the requesting organization will be returned. If false or not provided, all entities will be returned.
foreignIdstringOptional
ID used to identify this entity in your system
statusenumOptional
isPayeebooleanOptional
If true, entities that are marked as payees will be returned. If false or not provided, entities that are marked as payees will not be returned.
isPayorbooleanOptional
If true or not provided, entities that are marked as payors will be returned. If false, entities that are marked as payors will not be returned.
namestringOptional
Filter entities by name. Partial matches are supported.
limitintegerOptional
Number of entities to return. Limit can range between 1 and 100, and the default is 10.
startingAfterstringOptional
The ID of the entity to start after. If not provided, the first page of entities will be returned.

Response

This endpoint returns an object
count
integer
Total number of entities for the given filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.
hasMore
boolean
True if there are more entities available for the given filters.
data
list of objects