get
https://{Host}/launchpad/api/v2/Users/
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Allows you to retrieve the details of a specific user in your organisation by their ID. You can use either the numeric ID or the SCIM ID to fetch the user. The API returns the user's name, email address, active status, and assigned role.
Example request
curl --location 'https://eu.api.capillarytech.com/launchpad/api/v2/Users/50795539' \
--header 'Authorization: Bearer 7351f986b6c1ce4856883b5b1ca12b277eb3c483b5168613664505170eabac1d' \
--header 'Cookie: CS=e3f2bfa2cd6323fbddfa034e226084b8'Prerequisites
- A valid SCIM bearer token for your organization, generated using the Create SCIM Token API. Pass it in the request header as
Authorization: Bearer {token}.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the user you want to retrieve. Accepts either a numeric ID (e.g. 50795539) for users created directly in the system, or a SCIM ID (e.g. scim-1777291410320) for users onboarded through the SCIM flow. |
Example response
{
"id": "scim-1780291539381",
"userName": "[email protected]",
"name": {
"givenName": "Cap",
"familyName": "demo"
},
"displayName": "Cap demo",
"emails": [
{
"value": "[email protected]",
"type": "work",
"primary": true
}
],
"active": true,
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
]
}Response parameters
| Field | Type | Description |
|---|---|---|
schemas | array | Indicates the type of resource being returned. Always returns "urn:ietf:params:scim:schemas:core:2.0:User" for a single user response. |
id | string | The unique ID of the retrieved user in the Capillary system. This is the same ID you passed in the request. |
userName | string | The unique identifier of the retrieved user, typically their email address. |
displayName | string | The name displayed for the retrieved user on the platform. |
active | boolean | Indicates whether the retrieved user's account is currently active. |
name.givenName | string | The first name of the retrieved user. |
name.familyName | string | The last name of the retrieved user. |
emails | array | The email addresses associated with the retrieved user. |
emails.value | string | The email address of the retrieved user. |
emails.type | string | The type of email address of the retrieved user. Always returns work. |
emails.primary | boolean | Indicates whether this is the retrieved user's primary email address. Always returns true. |
Error codes
| Code | Type | Description |
|---|---|---|
| 401 | Error | Authorization header is missing or is not a valid Bearer token. |
| 403 | Error | Token is invalid or not associated with any org. |
| 404 | Error | No user was found for the given ID in the org. |
