Authentication

Peerlogic API requests use Bearer access tokens. Request a token with your Peerlogic credentials, then include that token in the Authorization header on subsequent requests.

Authentication flow

Request an access token from the token endpoint using your Peerlogic username and password.
Copy the access_token value from the response.
Include the token in the Authorization header for every secured API request.
Request a new token when the current token expires or the API returns 401 Unauthorized.

Access to individual resources is determined by the permissions assigned to your Peerlogic account. A valid token can still receive 403 Forbidden when the account does not have access to the requested resource.

Request a token

Send a form-encoded POST request to:

https://api.prod.peerlogic.com/api/oauth/token/

The request accepts the following values:

string

required

Your Peerlogic username, usually your email address.

string

required

The password associated with your Peerlogic account.

string

default:"password"

Use password.

string

default:"json"

Use json.

curl --request POST \
  --url https://api.prod.peerlogic.com/api/oauth/token/ \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=password' \
  --data-urlencode 'format=json' \
  --data-urlencode 'username=<YOUR_USERNAME>' \
  --data-urlencode 'password=<YOUR_PASSWORD>'

Token response

A successful response includes an access token, refresh token, expiration period, token type, and granted scope.

{
  "access_token": "<ACCESS_TOKEN>",
  "refresh_token": "<REFRESH_TOKEN>",
  "expires_in": 86400,
  "token_type": "Bearer",
  "scope": "offline_access"
}

Authorize a request

Add the access token to the Authorization header. The word Bearer must precede the token, separated by a space:

Authorization: Bearer <ACCESS_TOKEN>

curl --request GET \
  --url https://api.prod.peerlogic.com/api/calls/ \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --header 'Accept: application/json'

When using Try it in this API reference, enter the access token in the Authorization field. Mintlify adds the Bearer authentication header to the request.

Authentication errors

Status	Meaning	What to do
`400 Bad Request`	The token request is missing a required value or contains an invalid value.	Verify the form fields and submit the request again.
`401 Unauthorized`	The credentials are invalid, the access token is missing, or the access token has expired.	Verify the credentials or request a new access token.
`403 Forbidden`	Authentication succeeded, but the account cannot access the requested resource.	Confirm that the account has access to the requested organization or practice.

Treat credentials, access tokens, and refresh tokens as secrets. Do not place them in browser code, logs, or source control.

Next step

Use your token to make your first API request. To determine which customer resources your account can use, see Organization and practice access.

Start here

Core Concepts

Workflows

Authentication flow

Request a token

Token response

Authorize a request

Authentication errors

Next step

​Authentication flow

​Request a token

​Token response

​Authorize a request

​Authentication errors

​Next step

Authentication flow

Request a token

Token response

Authorize a request

Authentication errors

Next step