Skip to main content

Retrieve a person​

Get a person object by its ID. The function returns the decrypted, abridged person record.

Please use the Attributes API to retrieve custom person attributes.

Path Parameters
  • person_id string required

    The person ID

    Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Query Parameters
  • fields string[]

    Possible values: [handles, groups, attributes]

    Optional fields to include in the response

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

    Abridged person structure

  • 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]

  • roles string[]

    A list of roles to assign the person to. Roles must already exist. Roles have format {organization_id}/{role_name}. Roles can be created with this API endpoint.

  • 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*