Skip to main content
GET
/
api
/
scim
/
v2
/
Users
List users
curl --request GET \
  --url https://app.trelica.com/api/scim/v2/Users
{
  "totalResults": 2,
  "itemsPerPage": 100,
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "erika.mustermann@example.com",
      "name": {
        "formatted": "Erika Mustermann",
        "familyName": "Mustermann",
        "givenName": "Erika"
      },
      "displayName": "Erika Mustermann",
      "title": "Customer Success Manager",
      "preferredLanguage": "en-GB",
      "locale": "en-GB",
      "active": true,
      "emails": [
        {
          "primary": true,
          "type": "work",
          "value": "erika.mustermann@example.com"
        }
      ],
      "roles": [
        {
          "value": "Admin",
          "display": "Admin",
          "primary": false
        }
      ],
      "id": "8089ac9b31841227d4aee4f0adecd81f",
      "meta": {
        "created": "2019-01-01T00:00:00Z",
        "lastModified": "2024-12-06T14:58:12Z",
        "resourceType": "User"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "steve.cross@example.com",
      "name": {
        "formatted": "Steve Cross",
        "familyName": "Cross",
        "givenName": "Steve"
      },
      "displayName": "Steve Cross",
      "preferredLanguage": "en-GB",
      "locale": "en-GB",
      "active": true,
      "emails": [
        {
          "primary": true,
          "type": "work",
          "value": "steve.cross@example.com"
        }
      ],
      "roles": [
        {
          "value": "App catalog",
          "display": "App catalog",
          "primary": false
        },
        {
          "value": "App management",
          "display": "App management",
          "primary": false
        }
      ],
      "id": "b1c2d3e4f5061728394a5b6c7d8e9f00",
      "meta": {
        "created": "2020-03-09T06:09:26Z",
        "lastModified": "2024-05-26T01:01:43Z",
        "resourceType": "User"
      }
    }
  ]
}

Query Parameters

startIndex
integer<int32>
default:0

The 1-based index of the first result to return.

count
integer<int32>

The maximum number of results per page (default and maximum 100).

filter
string

An optional SCIM filter expression (RFC 7644 §3.4.2.2). Examples: userName eq "john.doe@example.com" (a specific user); active eq true (enabled users); userName sw "john" (user names starting with "john"); name.familyName eq "Smith".

Response

OK

totalResults
integer<int32>

The total number of results matching the query, across all pages.

itemsPerPage
integer<int32>

The number of results returned in this page.

startIndex
integer<int32>

The 1-based index of the first result in this page.

schemas
string[]

The SCIM schema URIs for this response. Always the SCIM ListResponse schema.

Resources
object[]

The resources returned in this page.