Skip to main content

Retrieve a list of persons​

Retrieve the full list of persons in your organization.

Query Parameters
  • handle string

    Filter by handle in format [handle_type]:[handle]. This field should be url-encoded.

    Example (email_address): email_address:user@user.com
    Example (phone_number): phone_number:+13475043201
    Example (username): username:john_smith
  • filter string

    A filter to be applied to the result list, using the SCIM 2.0 Filter syntax.

    Example (person_id): person_id eq "063e2964-ea22-76a2-ae08-3a7173964ae5"
    Example (handle_phone): handles eq "phone_number:+12019876543"
    Example (handle_email): handles eq "email_address:john.smith@example.com"
    Example (handle_username): handles eq "username:john_smith"
    Example (active): active eq true
    Example (admin_role): roles eq "admin"
    Example (permission_write): permissions eq "write"
    Example (additional_permission_write): additional_permissions eq "write"
    Example (groups_g1): groups eq "G1"
    Example (region_us): region eq "us-iowa"
    Example (region_not_us): region ne "us-iowa"
    Example (region_us_eu): region eq "us-iowa" or region eq "europe-belgium"
    Example (attribute_name): attributes eq "myconfig"
    Example (attribute_prefix): attributes sw "myprefix"
    Example (attribute_bucket_and_name): attribute_buckets[name eq "mybucket" and attributes eq "myconfig"]
    Example (attribute_in_ro_buckets): attribute_buckets[end_user_permissions eq "read_only" and attributes pr]
    Example (attribute_in_pool_buckets): attribute_buckets[sharing_scope eq "person_pool" and attributes pr]
  • limit integer

    Possible values: <= 1000

    The maximum number of items to return in the result. Maximum value is 1000.

  • offset integer

    The number of the first item to be returned in the result

  • ids string[]

    A comma-separated list of person IDs

    Example: 064d3697-4bf6-781e-9a08-303683b8a5e6,064d3f71-475e-7ea4-9808-6b72d038a43f
  • fields string[]

    Possible values: [handles, groups, attributes]

    Optional fields to include in the response

  • all_regions boolean

    Default value: true

    If true, users from all regions will be returned. Defaults to true.

  • all_person_types boolean

    If true, also returns non-regular users. Defaults to false.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
  • result object[]
  • active boolean

    A flag indicating whether the person is active or not

  • person_id string

    The ID of the person

  • person_type string

    Possible values: [regular, anonymous]

  • region string

    Possible values: [us-iowa, europe-belgium, asia-japan, europe-england, australia-sydney]

  • handles object[]
  • type string

    Possible values: [email_address, phone_number, username]

  • value string
  • groups string[]

    Possible values: <= 100 characters, Value must match regular expression ^[A-Za-z0-9]{1}[\w\.\-]*[A-Za-z0-9]$

  • attributes object

    Attributes divided into named buckets. Bucket names are top level keys; attributes are values. Attributes consist of key-value pairs. Attribute names (keys) may be at most 70 bytes long. Attribute values must be JSON-serializable and are limited to 64KiB.

  • property name*