> ## Documentation Index
> Fetch the complete documentation index at: https://developer.sendoso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get All Users

> Get all users

### Parameters

<ParamField query="startIndex" type="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`
</ParamField>

<ParamField query="count" type="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`
</ParamField>

### Response

<ResponseField name="schemas" type="array" required>
  The SCIM RFC schema for the User List resource - always `urn:ietf:params:scim:api:messages:2.0:ListResponse`
</ResponseField>

<ResponseField name="itemsPerPage" type="integer" required>
  Non-negative integer. Specifies the number of query results returned in a query response page, e.g., `10`.
</ResponseField>

<ResponseField name="startIndex" type="integer" required>
  Non-negative integer. Specifies the total number of results matching the client query, e.g., `1000`.
</ResponseField>

<ResponseField name="totalResults" type="integer" required>
  The 1-based index of the first result in the current set of query results, e.g., `1`.
</ResponseField>

<ResponseField name="Resources" type="array" required>
  <Expandable title="Resources" defaultOpen="true">
    <ResponseField name="id" type="string" required>
      The user's identifier
    </ResponseField>

    <ResponseField name="userName" type="string" required>
      The user's email address
    </ResponseField>

    <ResponseField name="active" type="boolean" required>
      Whether or not the user is active or not in the Sendoso platform.
    </ResponseField>

    <ResponseField name="name" type="object" required>
      <Expandable title="name" defaultOpen="true">
        <ResponseField name="givenName" type="string" required>
          The user's first name
        </ResponseField>

        <ResponseField name="familyName" type="string" required>
          The user's last name
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="emails" type="array" required>
      The user's personal balance
    </ResponseField>

    <ResponseField name="emails" type="array" required>
      <Expandable title="emails" defaultOpen="true">
        <ResponseField name="value" type="string" required>
          The user's email address
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="userType" type="string" required>
      The user's role. Values can be `sender`, `manager`, `admin`.
    </ResponseField>

    <ResponseField name="division" type="string" required>
      The user's team.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    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",
      }
    ]
  }
  ```
</ResponseExample>