List Entities

Use the /entity endpoint to retrieve a paginated list of entity (business) users. You can filter by entity name, email, and other entity-specific fields.

Filterable Fields:

  • entityName - The name of the entity/business
  • email - The entity's email address
  • phoneNumber - The entity's phone number
  • isArchived - Whether the entity is archived
  • createdAt - The date the entity was created
  • clientUserId - Your internal identifier for the entity
  • _id - The entity's unique identifier

Supported Operators:

  • eq - Equals
  • ne - Not equals
  • contains - Contains (case-insensitive partial match)
  • startsWith - Starts with
  • gt, gte, lt, lte - Comparison operators (useful for dates)
Language
Credentials
Response
Click Try It! to start a request and see the response here!