v1 API documentation

Read licenses

GET /me/licenses

Read all licenses for a profile. Receive in return the identifiers for an organization and the connected person within that company. This information can be used as a login hint to get an access token for operational work on behalf of the connected person.

Headers

Authorization string Required

Authorization header

Query parameters

organizationId integer(int64)

Identifier for the organization.
personId integer(int32)

Identifier for the connected person.

Responses

• 200 application/json

Success
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
- Access-Control-Allow-Credentials string
- X-Trace-Id string
Hide response attributes Show response attributes object
- id string(uuid)
  
  The unique identifier for the license.
- name string | null
  
  The name of the organization.
- organizationId integer(int64) | null
  
  The identifier for the organization.
- identityId string(uuid) | null
  
  The identifier for the connected person's identity.
- personId integer(int32) | null
  
  The identifier for the connected person.
- Additional properties are NOT allowed

GET /me/licenses

curl \
 -X GET https://rest.api.24sevenoffice.com/v1/me/licenses \
 -H "Authorization: string"

Response examples (200)

# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string

# Payload
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174003",
    "name": "ABC Corporation",
    "organizationId": 12345,
    "identityId": "123e4567-e89b-12d3-a456-426614174001",
    "personId": 67890
  },
  {
    "id": "123e4567-e89b-12d3-a456-426614174004",
    "name": "XYZ Inc.",
    "organizationId": 78901,
    "identityId": "123e4567-e89b-12d3-a456-426614174002",
    "personId": 54321
  }
]