Get Users

Deprecated

GET

/api/v5/rest/org/:organization_slug/users/

GET

/api/v5/rest/org/:organization_slug/users/

$ curl https://qa.creha.co/api/v5/rest/org/organization_slug/users/ \
>      -H "Secret-Access: Secret-Access" \
>      -H "Api-Key: <apiKey>"

1 {
2   "message": "Users retrieved correctly.",
3   "code": "user-001",
4   "datetime": "2021-10-08T16:23:05.000000",
5   "data": [
6     {
7       "id": 1,
8       "first_name": "John",
9       "last_name": "Doe",
10       "email": "jhondoe@example.com",
11       "area_id": 1,
12       "position_id": 1,
13       "position_category_id": 1,
14       "role": "Admin",
15       "headquarter_id": 1,
16       "boss_id": 2,
17       "document_type": "passport",
18       "document": "A1234567",
19       "gender": "male",
20       "civil_status": "single",
21       "phone_1": "123456789",
22       "phone_2": "987654321",
23       "address": "Calle Falsa 123",
24       "city": "Bogota",
25       "country": "Colombia",
26       "deactivation_date": "2022-12-31",
27       "incorporation_date": "2021-12-31",
28       "status": "ACTIVE",
29       "invitation_sent": true,
30       "custom_fields": [
31         {
32           "id": 1,
33           "value": "Value 1",
34           "choice_id": 1
35         }
36       ]
37     },
38     {
39       "id": 2,
40       "first_name": "Jane",
41       "last_name": "Doe",
42       "email": "janedoe@example.com",
43       "area_id": 2,
44       "position_id": 2,
45       "position_category_id": 2,
46       "role": "User",
47       "headquarter_id": 2,
48       "boss_id": 3,
49       "document_type": "id",
50       "document": "B7654321",
51       "gender": "female",
52       "civil_status": "married",
53       "phone_1": "987654321",
54       "phone_2": "123456789",
55       "address": "Avenida Siempre Viva 742",
56       "city": "Medellin",
57       "country": "Colombia",
58       "deactivation_date": "2023-12-31",
59       "incorporation_date": "2020-12-31",
60       "status": "PENDING",
61       "invitation_sent": false,
62       "custom_fields": [
63         {
64           "id": 2,
65           "value": "Value 2",
66           "choice_id": 2
67         }
68       ]
69     }
70   ],
71   "next_cursor": "YXJyYXljb25uZWN0aW9uOjA=",
72   "has_next_page": true,
73   "total_count": 4
74 }

Returns a list of users from the organization.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Query parameters

cursorstringOptional

limitintegerOptionalDefaults to 10

versionintegerOptionalDefaults to 1

searchstringOptional

Response

Successful Response

messagestring

Message of the response

codestring

Internal code of the response

datetimestring

Datetime of the API in ISO Format

datalist of objectsOptional

next_cursorstringOptional

has_next_pagebooleanOptional

total_countintegerOptional

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors