entity > user

Search entity users

Search entity users

get/entity/{entityId}/users

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}/users
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

Query parameters

foreignIdstring

ID used to identify user in your system

rolestring

Filter users by role. If multiple roles are provided, users with any of the roles will be returned.

namestring

Filter users by name. Partial matches are supported.

emailstring

Filter users by email. Partial matches are supported.

limitinteger

Number of entities to return. Limit can range between 1 and 100, and the default is 10.

startingAfterstring

The ID of the user to start after. If not provided, the first page of entities will be returned.

Response

Response with status 200

countinteger required

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 required

True if there are more users available for the given filters.

Changes

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