The users endpoint returns users of a specific app.
Users for your app are primarily created using Connect. This endpoint is best used for management of existing users.
As a part of the Application API this endpoint is authenticated using Basic Authentication. You must use your App Key as username and a blank password. Make sure you include the “:” after the username to avoid being asked to enter a password.
For a more detailed description on how to manage your app’s users, see the documentation here.
Returns a list of users
GET https://api.humanapi.co/v1/apps/{appId}/users
Returns a single user
GET https://api.humanapi.co/v1/apps/{appId}/users/{humanId}
# Returns a json array of users
[
{
"humanId": "0a34dca6b9fe0b2361038bd371d96539",
"externalId": "[email protected]",
"appId": "1d129c20acf6fcef9be0b067cc7859d872ed5ade",
"createdAt": "2013-12-28T18:46:10.436Z",
"updatedAt": "2013-12-29T05:05:50.601Z"
},
{
"humanId": "8bd9999a4f902e609343dcb850361f23",
"externalId": "[email protected]",
"appId": "1d129c20acf6fcef9be0b067cc7859d872ed5ade",
"createdAt": "2013-12-28T23:46:37.701Z",
"updatedAt": "2013-12-28T23:46:37.701Z"
},
{
"humanId": "f29b82027297553353acbf4901683830",
"externalId": "[email protected]",
"appId": "1d129c20acf6fcef9be0b067cc7859d872ed5ade",
"createdAt": "2013-12-29T05:08:11.610Z",
"updatedAt": "2013-12-29T05:08:11.610Z"
}
]
# Get all users associated with an app
curl -X GET -H 'Accept: application/json' -u e7db255f4828e1d482743eba04faacb945ab7ca8: https://api.humanapi.co/v1/apps/1d129c20acf6fcef9be0b067cc7859d872ed5ade/users
Response Properties
| Property | Type | Description |
|---|---|---|
| humanId | String | The id of the user in Human API |
| externalId | String | The id of the user provided from your application |
| appId | String | Unique app identifier found in the Developer Portal. |
| createdAt | Date | The time the measurement was created on the Human API server |
| updatedAt | Date | The time the measurement was updated on the Human API server |
Deletes a user
DELETE https://api.humanapi.co/v1/apps/{appId}/users/{humanId}
The response code for this is 204
# Delete a user
curl -X DELETE -u 1cf3900bd3968ab34344c9318342f6c3ca1456d3: https://api.humanapi.co/v1/apps/1479b39aa3476f92d7569485e3b3f6f773642ef/users/2242b2440ef1aab43719f202af316a2a
# Returns status code
204