GET /api/v1/users/getUserByExternalId/{externalId}/{externalPlatform}
Retrieve a user when providing an external ID and an external platform.
Response
Body
| Property | Type | Example/values | Required? | Description |
|---|---|---|---|---|
_id | ObjectId as string | "5b56f4c392af558eb5f1386c" | Yes | The ID of the user matching the request |
mail | string | "dummy_user1@360learning.com" | Yes | The mail of the user matching the request |
firstName | string | "John" | No | The first name of the user matching the request |
lastName | string | "Doe" | No | The last name of the user matching the request |
primaryGroupId | string | 5ae6f128331332775cfb14be | No | Primary group of the user, if any. |
Success
{
"_id": "5b56f4c392af558eb5f1386c",
"mail": "dummy_user1@360learning.com",
"firstName": "John",
"lastName": "Doe"
}
Errors
| Status code | Error body | Reason |
|---|---|---|
401 | { "error": "{{usual_route_authentication_errors}}" } | Bad authentication (missing/unmatching/unexisting authentication) |
404 | { "error": "user_not_found" } | User doesn't belong to the company |
404 | { "error": "user_not_found" } | External ID doesn't belong to the company |
404 | { "error": "user_not_found" } | User is deleted |
404 | { "error": "externalPlatform_not_found" } | External platform doesn't exist for the company |
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
externalPlatform |
String | Yes |
Name of the HRIS. Possible values: BambooHR, SAP SuccessFactors, Cornerstone, Oracle. |
externalId |
String | Yes |
ID of the user in the external platform |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.