Skip to main content

Getting a Company Integrator Token

A company integrator (access) token grants permission for a third-party to access a particular company and some or all of its sites. The level of access depends on the assigned company role.

Follow the steps below to get an access token:

  1. Obtain an access token by sending a POST request to /v1/company-integrator/access-token, with a key and secret_keyin the body of the request. The example below shows the URL and request body:

    Company Integrator Token URL

    {{pb_url}}/v1/company-integrator/access-token

    Integrator Token Request Body

    {
    "key_id": "{{key_id}}",
    "secret_key": "{{secret_key}}",
    "company_id": "{{company_id}}"
    }
  2. The response to this request contains a string, which serves as an authorization token for future calls to our API resources.

POST /v1/company-integrator/access-token

Summary

Use the POST /v1/company-integrator/access-token endpoint to generate a company integrator (access) token for a particular company and its sites.

Request Parameters

In

Field Name

Type

Required

Description

header

CONTENT-TYPE

string

Yes

application/json

header

AUTHORIZATION

string

Yes

The integrator token created previously

body

body

PostCompanyIntegratorTokenRequestBody

Yes

The key identifier, secret key, and company identifier (ID) used to obtain a company integrator token

Responses

Code

Description

200

Success

Message: Token returned in response body.

401

Error

Message: Invalid credentials provided.

PostCompanyIntegratorTokenRequestBody

Field Name

Type

Required

Description

key_id

string

Yes

The key identifier for the integrator

secret_key

string

Yes

The secret key for the integrator

company-id

string

Yes

The target company unique identifier (UID) for which a token should be generated