Read people

GET /organization/people
Tfso

Read a list of all people under the organization.

24SevenOffice is a multi-tenant application, where a personal login gives access to more than one organization and its people.

Hence, there exist "identity", "organization" and the organization’s "people".

Identity → *Organization → *Person


People A person is owned by an organization, and will usually be an employee or an owner of the organization. A person may be connected to an identity. An identity connected to a person may have a certain role in an organization, that will result in a set of permissions called scopes.

Headers

Query parameters

  • personType string

    Type of person to filter by.

    Values are Organization, External, Basic, or Client.

Responses

  • 200

    Success

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • id integer(int32)

      The unique identifier for the person within 24SevenOffice.

    • identityId string(uuid) | null

      The identifier for the connected identity.

    • firstName string | null

      The first name of the person.

    • lastName string | null

      The last name of the person.

    • personType string

      Values are Organization, External, Basic, or Client.

    • hasLicense boolean

      A flag variable indicating whether the person has a license.

    Hide response attributes Show response attributes object
    • id integer(int32)

      The unique identifier for the person within 24SevenOffice.

    • identityId string(uuid) | null

      The identifier for the connected identity.

    • firstName string | null

      The first name of the person.

    • lastName string | null

      The last name of the person.

    • personType string

      Values are Organization, External, Basic, or Client.

    • hasLicense boolean

      A flag variable indicating whether the person has a license.

    Hide response attributes Show response attributes object
    • id integer(int32)

      The unique identifier for the person within 24SevenOffice.

    • identityId string(uuid) | null

      The identifier for the connected identity.

    • firstName string | null

      The first name of the person.

    • lastName string | null

      The last name of the person.

    • personType string

      Values are Organization, External, Basic, or Client.

    • hasLicense boolean

      A flag variable indicating whether the person has a license.
GET /organization/people 
curl \
 --request GET 'https://rest.api.24sevenoffice.com/v1/organization/people' \
 --header "Authorization: string"
Response examples (200) 
[{"id"=>123, "lastName"=>"Doe", "firstName"=>"John", "hasLicense"=>true, "identityId"=>"123e4567-e89b-12d3-a456-426614174001", "personType"=>"Organization"}, {"id"=>456, "lastName"=>"Smith", "firstName"=>"Jane", "hasLicense"=>false, "identityId"=>"123e4567-e89b-12d3-a456-426614174002", "personType"=>"External"}]
Response examples (200) 
[
  {
    "id": 123,
    "lastName": "Doe",
    "firstName": "John",
    "hasLicense": true,
    "identityId": "123e4567-e89b-12d3-a456-426614174001",
    "personType": "Organization"
  },
  {
    "id": 456,
    "lastName": "Smith",
    "firstName": "Jane",
    "hasLicense": false,
    "identityId": "123e4567-e89b-12d3-a456-426614174002",
    "personType": "External"
  }
]
Response examples (200) 
[
  {
    "id": 123,
    "lastName": "Doe",
    "firstName": "John",
    "hasLicense": true,
    "identityId": "123e4567-e89b-12d3-a456-426614174001",
    "personType": "Organization"
  },
  {
    "id": 456,
    "lastName": "Smith",
    "firstName": "Jane",
    "hasLicense": false,
    "identityId": "123e4567-e89b-12d3-a456-426614174002",
    "personType": "External"
  }
]