Get Members By Organisation

POST

https://api.staple.io/v1/users/members

POST

/v1/users/members

$ curl -X POST https://api.staple.io/v1/users/members \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Get Members By Organisation

1 {
2   "getListMembers": {
3     "data": [
4       {
5         "createdAt": 1578047471603,
6         "email": "member1@gmail.com",
7         "firstName": "Organisation A",
8         "id": 1,
9         "lastName": "Employee",
10         "organisation": null,
11         "phoneNumber": "095950595",
12         "position": "Employee",
13         "queuesAccess": 11
14       },
15       {
16         "createdAt": 1583998168286,
17         "email": "member2@staple.io",
18         "firstName": "Josh",
19         "id": 2,
20         "lastName": "Dude",
21         "organisation": null,
22         "phoneNumber": "095950595",
23         "position": "Employee",
24         "queuesAccess": 9
25       },
26       {
27         "createdAt": 1585722687291,
28         "email": "member3@gmail.com",
29         "firstName": "Demo account",
30         "id": 3,
31         "lastName": "Employee",
32         "organisation": null,
33         "phoneNumber": "095950595",
34         "position": "Employee",
35         "queuesAccess": 3
36       },
37       {
38         "createdAt": 1587636399919,
39         "email": "member4@gmail.com",
40         "firstName": "Demo account",
41         "id": 4,
42         "lastName": "Employee",
43         "organisation": null,
44         "phoneNumber": "095950595",
45         "position": "Employee",
46         "queuesAccess": 3
47       }
48     ],
49     "pageInfo": {
50       "hasNextPage": false,
51       "hasPreviousPage": false,
52       "lastCursor": 106
53     },
54     "total": 4
55   }
56 }

This endpoint allows you to get a list of your team members.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

paginationobjectOptional

Authentication

Request

Response