Get Centralized User Organizations

GET

/api/v5/rest/org/:organization_slug/users/user-organizations/

GET

/api/v5/rest/org/:organization_slug/users/user-organizations/

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

1 {
2   "results": [
3     {
4       "id": "string",
5       "user": {
6         "id": "string",
7         "email": "string",
8         "first_name": "string",
9         "last_name": "string",
10         "username": "string"
11       },
12       "status": "string",
13       "role": "string",
14       "area": {
15         "id": "string",
16         "label": "string",
17         "name": "string"
18       },
19       "position": {
20         "id": "string",
21         "name": "string"
22       },
23       "position_category": {
24         "id": "string",
25         "name": "string"
26       },
27       "created_at": "2024-01-15T09:30:00Z",
28       "document_type": "string",
29       "document": "string",
30       "civil_status": "string",
31       "country_code": "string",
32       "headquarter": {
33         "id": "string",
34         "name": "string"
35       },
36       "incorporation_date": "2023-01-15",
37       "birthday_date": "2023-01-15",
38       "updated_at": "2024-01-15T09:30:00Z",
39       "learning_user_id": "string",
40       "learning_user_organization_id": "string",
41       "talent_employee_id": "string",
42       "custom_fields": [
43         {
44           "id": 1,
45           "value": "string",
46           "choice_id": 1
47         }
48       ]
49     }
50   ],
51   "total": 1
52 }

Purpose: This endpoint returns a paginated list of all users loaded in the platform, including their organizational structure and the IDs required to interact with information from other modules, also include Extra Fields.

Authentication

Api-Keystring

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

Path parameters

organization_slugstringRequired

Query parameters

statusstringOptional

area_idintegerOptional

area_namestringOptional

headquarter_idintegerOptional

headquarter_namestringOptional

position_idintegerOptional

position_namestringOptional

position_category_idintegerOptional

position_category_namestringOptional

rolestringOptional

documentstringOptional

searchstringOptional

limitintegerOptional1-100

offsetintegerOptional>=0

Response

Successful Response

resultslist of objects

totalintegerOptional

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors