Time	Status	User Agent
Retrieving recent requests…

Allows you to retrieve a list of all users who have been granted access to the Capillary platform under your organisation. The API returns each user's details including their name, email address, active status, and assigned role.

Example request

curl --location 'https://eu.api.capillarytech.com/launchpad/api/v2/Users' \
--header 'Authorization: Bearer a7ba38a39712dff766414c43ef23dbf3c8d5138fd9db3ec3916b09a7a48da0c3' \
--header 'Accept: application/json'

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}.

Resource information


Pagination support	No
Filter support	Yes

Example response

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 7,
    "startIndex": 1,
    "itemsPerPage": 7,
    "Resources": [
        {
            "id": "15071474",
            "userName": "",
            "name": {
                "givenName": "SUPER USER",
                "familyName": ""
            },
            "displayName": "SUPER USER",
            "emails": [],
            "active": true,
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ]
        },
        {
            "id": "50024381",
            "userName": "[email protected]",
            "name": {
                "givenName": "Vivek",
                "familyName": "Khatri"
            },
            "displayName": "Vivek Khatri",
            "emails": [
                {
                    "value": "[email protected]",
                    "type": "work",
                    "primary": true
                }
            ],
            "active": true,
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ]
        },
        {
            "id": "50712442",
            "userName": "[email protected]",
            "name": {
                "givenName": "upgrade",
                "familyName": "test1"
            },
            "displayName": "upgrade test1",
            "emails": [
                {
                    "value": "[email protected]",
                    "type": "work",
                    "primary": true
                }
            ],
            "active": true,
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ]
        },
        {
            "id": "50779683",
            "userName": "[email protected]",
            "name": {
                "givenName": "arya-text",
                "familyName": "proxy"
            },
            "displayName": "arya-text proxy",
            "emails": [
                {
                    "value": "[email protected]",
                    "type": "work",
                    "primary": true
                }
            ],
            "active": true,
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ]
        },
        {
            "id": "50781523",
            "userName": "[email protected]",
            "name": {
                "givenName": "Steephan",
                "familyName": "Raj"
            },
            "displayName": "Steephan Raj",
            "emails": [
                {
                    "value": "[email protected]",
                    "type": "work",
                    "primary": true
                }
            ],
            "active": true,
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ]
        },
        {
            "id": "50785952",
            "userName": "[email protected]",
            "name": {
                "givenName": "redis-scan",
                "familyName": ""
            },
            "displayName": "redis-scan",
            "emails": [
                {
                    "value": "[email protected]",
                    "type": "work",
                    "primary": true
                }
            ],
            "active": true,
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ]
        },
        {
            "id": "50794631",
            "userName": "[email protected]",
            "name": {
                "givenName": "Intouch",
                "familyName": "test"
            },
            "displayName": "Intouch test",
            "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 response being returned. Always returns `"urn:ietf:params:scim:api:messages:2.0:ListResponse"` for list responses.
`totalResults`	number	The total number of users returned for the org.
`startIndex`	number	The starting index of the returned results. Always `1` as pagination is not supported.
`itemsPerPage`	number	The number of users returned in this response. Same as `totalResults` since all users are returned in a single response.
`Resources`	array	The list of user objects. Returns an empty array if no users exist for the org.
`Resources.id`	string	The unique ID assigned to the user by Capillary. Used to identify the user in subsequent SCIM operations such as update or delete.
`Resources.userName`	string	The unique identifier of the user, typically their email address.
`Resources.displayName`	string	The name displayed for the user on the platform.
`Resources.active`	boolean	Indicates whether the user account is active.
`Resources.name.givenName`	string	The first name of the user.
`Resources.name.familyName`	string	The last name of the user.
`Resources.emails`	array	The email addresses associated with the user.
`Resources.emails.value`	string	The email address of the user.
`Resources.emails.type`	string	The type of email address. Always returns `work` for users fetched from the platform.
`Resources.emails.primary`	boolean	Indicates whether this is the user's primary email address. Always returns `true`.

Error & warning 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.