entityGroupIdstringRequiredEntity Group ID or Entity Group ForeignID
Query parameters
foreignIdstringOptionalID used to identify user in your system
rolestringOptionalFilter users by role. If multiple roles are provided, users with any of the roles will be returned.
namestringOptionalFilter users by name. Partial matches are supported.
emailstringOptionalFilter users by email. Partial matches are supported.
limitintegerOptionalNumber of entities to return. Limit can range between 1 and 100, and the default is 10.
startingAfterstringOptionalThe ID of the user to start after. If not provided, the first page of entities will be returned.
Response
This endpoint returns an object
countinteger
Total number of users 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.
hasMoreboolean
True if there are more users available for the given filters.