EntityUser

Search entity users

PUT
Search entity users

Path parameters

entityIdstringRequired

Query parameters

foreignIdstringOptional
ID used to identify user in your system
rolestringOptional
Filter users by role. If multiple roles are provided, users with any of the roles will be returned.
namestringOptional
Filter users by name. Partial matches are supported.
emailstringOptional
Filter users by email. 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 user 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 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.
hasMore
boolean
True if there are more users available for the given filters.
data
list of objects
PUT
1curl -X PUT "https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/users?name=John" \
2 -H "Authorization: Bearer <token>"
200Updated
1{
2 "count": 1,
3 "hasMore": false,
4 "data": [
5 {
6 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
7 "roles": [
8 "admin",
9 "approver"
10 ],
11 "createdAt": "2024-01-01T00:00:00Z",
12 "updatedAt": "2024-01-01T00:00:00Z",
13 "foreignId": "MY-DB-ID-12345",
14 "email": "john.doe@acme.com",
15 "name": "John Doe"
16 }
17 ]
18}