GET
/
api
/
scim
/
v2
/
Users
curl --request GET \
  --url https://app.sendoso.com/api/scim/v2/Users \
  --header 'Authorization: Bearer <token>'
{
  schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"],
  itemsPerPage: 2,
  startIndex: 1,
  totalResults: 100,
  Resources: [
    {
      id: "1000",
      userName: "john.doe@sendoso.com",
      active: false,
      name: {
        givenName: "John",
        familyName: "Doe",
      },
      emails: [
        { value: "john.doe@sendoso.com" },
      ],
      userType: "sender",
      division: "Marketing Ops",
    },
    {
      id: "2000",
      userName: "jane.doe@sendoso.com",
      active: true,
      name: {
        givenName: "Jane",
        familyName: "Doe",
      },
      emails: [
        { value: "jane.doe@sendoso.com" },
      ],
      userType: "admin",
      division: "Sales",
    }
  ]
}

​
Parameters

​
startIndex
integer

The 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1. By default this value is 1

​
count
integer

Non-negative integer. Specifies the desired maximum number of query results per page, e.g., 10. When specified, the service provider MUST NOT return more results than specified, although it MAY return fewer results. If unspecified, the maximum will be 100

​
Response

​
schemas
array
required

The SCIM RFC schema for the User List resource - always urn:ietf:params:scim:api:messages:2.0:ListResponse

​
itemsPerPage
integer
required

Non-negative integer. Specifies the number of query results returned in a query response page, e.g., 10.

​
startIndex
integer
required

Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000.

​
totalResults
integer
required

The 1-based index of the first result in the current set of query results, e.g., 1.

​
Resources
array
required
{
  schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"],
  itemsPerPage: 2,
  startIndex: 1,
  totalResults: 100,
  Resources: [
    {
      id: "1000",
      userName: "john.doe@sendoso.com",
      active: false,
      name: {
        givenName: "John",
        familyName: "Doe",
      },
      emails: [
        { value: "john.doe@sendoso.com" },
      ],
      userType: "sender",
      division: "Marketing Ops",
    },
    {
      id: "2000",
      userName: "jane.doe@sendoso.com",
      active: true,
      name: {
        givenName: "Jane",
        familyName: "Doe",
      },
      emails: [
        { value: "jane.doe@sendoso.com" },
      ],
      userType: "admin",
      division: "Sales",
    }
  ]
}