-
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
, orClient
. -
hasLicense boolean
A flag variable indicating whether the person has a license.
Read people
GET
/organization/people
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
.
Query parameters
-
personType string
Type of person to filter by.
Values are
Organization
,External
,Basic
, orClient
.
GET /organization/people
curl \
-X GET https://rest.api.24sevenoffice.com/v1/organization/people \
-H "Authorization: string"
Response examples (200)
# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string
# Payload
[
{
"id": 123,
"identityId": "123e4567-e89b-12d3-a456-426614174001",
"firstName": "John",
"lastName": "Doe",
"personType": "Organization",
"hasLicense": true
},
{
"id": 456,
"identityId": "123e4567-e89b-12d3-a456-426614174002",
"firstName": "Jane",
"lastName": "Smith",
"personType": "External",
"hasLicense": false
}
]
Response examples (200)
# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string
# Payload
[
{
"id": 123,
"identityId": "123e4567-e89b-12d3-a456-426614174001",
"firstName": "John",
"lastName": "Doe",
"personType": "Organization",
"hasLicense": true
},
{
"id": 456,
"identityId": "123e4567-e89b-12d3-a456-426614174002",
"firstName": "Jane",
"lastName": "Smith",
"personType": "External",
"hasLicense": false
}
]
Response examples (200)
# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string
# Payload
[
{
"id": 123,
"identityId": "123e4567-e89b-12d3-a456-426614174001",
"firstName": "John",
"lastName": "Doe",
"personType": "Organization",
"hasLicense": true
},
{
"id": 456,
"identityId": "123e4567-e89b-12d3-a456-426614174002",
"firstName": "Jane",
"lastName": "Smith",
"personType": "External",
"hasLicense": false
}
]