Issue an authenticated call
Once you get a token, you can use it to make calls to an API endpoint by appending an Authorization header. The header is the same regardless of the type of token.
The example below shows a call to retrieve a list of users:
GET /api/v1/users HTTP/1.1
Host: admin.humanapi.co
Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer <client-token>
Get users
To get a list of users associated with your provisioned Human API application, send a GET request with your client token. The request looks like this:
GET /api/v1/users HTTP/1.1
Host: admin.humanapi.co
Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer <client-token>
curl -X GET 'https://admin.humanapi.co/api/v1/users' \
-H 'Authorization: Bearer eyJraWQiOiJDMGNiRE1jV3V4bVkyckplZGw5MF93dXRHRVNGY21wSVQ4OTJpc2E1T1QwIiwiYWxnIjoiUlMyNTYifQ.eyJ2ZXIiOjEsImp0aSI6IkFULjNxdlhwbm9hZ3JDSGlTUi1nOTJFSlkxQW1UVEFXTnZIQmMxbG9oUVhXYmciLCJpc3MiOiJodHRwczovL2FjY291bnQuaHVtYW5hcGkuY28vb2F1dGgyL2F1czNmY3ZhbzJaM2ViU2hPMjk3IidiYXVkIjoiYWRtaW4uaHVtYW5waS5jbyIsImlhdCI6MTU4ODc4NTkwNSwiZXhwIjoxNTg4ODcyMzA1LCJjaWQiOiI5NmNiOGRhNDRhMmU2NjYzY2M0ZGQ3YWU4YzczNjNlOTIyYjVlMGY0Iiwic2NwIjpbImFwcHVzZXI6d3JpdGUiLCJhcHB1c2VyOnJlYWQiXSwic3ViIjoiOTZjYjhkYTd0YTJlNjY2M2NjNGRkN2FlOGM3MzYzZTkyMmI1ZTBmNCJ9.Nq-MThWyN7Rp8bG0rR91MP9mLR8F3GZRXgwbk8cdrDdWcNQdrGoEetZk56GJfl7BHnhkyoDO4d4EE04f4HYzJRXgo4k3s6fh6xrMMFjvMW4x9WqJ8mTK2kF56wYto45pL3b6UcnxrAX-PM_ooXRfWPWw130LQCW-G4cfww1Qb2_AlqSJYSeSnozXhMW08sA4HERDJ8UuHKX6Cklln-QIBPCGkU5I_JeDAdu9FaxbDZfJWTGbHhwC8s5SRYSSrq8OhoI3U3r29DFo2kT0ekdwbV_jPd4GkYSYYcGxh9QoAcj2ThTkntyIggH9hY9uUob0ckhLAUxDL6CGE1hXCscIfg'
A successful response yields a HTTP 200 status code and body with an array of user objects.
User Object Response Parameters
| Property | Type | Description |
|---|---|---|
| firstName | string | (Optional) Applicant's first name, as provided in order creation. |
| lastName | string | (Optional) Applicant's last name, as provided in order creation. |
| clientUserId | string | Your unique identifier as provided in order creation. |
| clientUserEmail | string | Applicant's email address. |
| humanId | string | HumanAPI's unique identifier for this order. |
| createdAt | timestamp | Time at which the order was created. |
| updatedAt | timestamp | Last time at which the order was updated. |
| status | string | DEPRECATED This value is not HIP supported; reflects a legacy status and should not be used. |
Sample response.
[
{
"firstName": "Sam",
"lastName": "Doe",
"clientUserId": "Human_441272526",
"clientUserEmail": "[email protected]",
"humanId": "b3301c8d6f5242fcf2e6455aa83423cf",
"createdAt": "2020-06-09T18:15:13.388Z",
"updatedAt": "2020-06-09T18:16:25.138Z",
"status": "All Synced"
},
{
"firstName": "John",
"lastName": "Doe",
"clientUserId": "Human_337596920",
"clientUserEmail": "[email protected]",
"humanId": "37db9784cd01029cf27f2eff22b476a3",
"createdAt": "2020-06-09T18:21:00.491Z",
"updatedAt": "2020-06-09T18:21:59.335Z",
"status": "Declined"
},
{
"firstName": "Jane",
"lastName": "Doe",
"clientUserId": "Human_478102855",
"clientUserEmail": "[email protected]",
"humanId": "fecfdd65dc1567481b22f6a043dde31a",
"createdAt": "2020-06-09T18:40:20.955Z",
"updatedAt": "2020-06-09T19:25:27.627Z",
"status": "Declined"
},
{
"firstName": "Tim",
"lastName": "Doe",
"clientUserId": "Human_399765218",
"clientUserEmail": "[email protected]",
"humanId": "89e05678d1a299e9f268d68ffe23dc13",
"createdAt": "2020-06-09T20:04:26.140Z",
"updatedAt": "2020-06-16T20:11:52.865Z",
"status": "Engaged"
},
{
"firstName": "James",
"lastName": "Doe",
"clientUserId": "Human_547887179",
"clientUserEmail": "[email protected]",
"humanId": "26b7edc263ac5b421dd8a826465d619a",
"createdAt": "2020-06-16T16:53:49.658Z",
"updatedAt": "2020-06-17T23:33:43.901Z",
"status": "Engaged"
}
]
Filter the list of users by clientUserId
You can filter out the response by clientUserId by providing the value as a query string parameter. See the API Reference for more details.
Get a single user
You can also check the details of one user by simply appending their humanId to the call. The request will resemble https://admin.humanapi.co/api/v1/users/b3301c8d6f5242fcf2e6455aa83423cy
Updated about 1 year ago