Quick Start

1. Create a Custom App

Before making API requests, a custom app must be created in the Consignly account to obtain API credentials. See the Authentication guide for detailed setup instructions.

2. Authenticate

All API requests require authentication. Consignly supports OAuth 2.0 with both Client Credentials and Authorization Code flows.

# Example: Obtain an access token
curl -X POST https://identity.consignlyhq.com/connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=CLIENT_ID" \
  -d "client_secret=CLIENT_SECRET"

3. Make the First Request

# Example: Get current user identity
curl -X GET https://api.consignlyhq.com/v1/identity \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response:

{
  "identityConnectionId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "userFullName": "John Smith",
  "organisationId": "00000000-0000-0000-0000-000000000000",
  "organisationName": "Example Logistics Co",
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "partnerCode": "ELC",
  "partnerName": "Example Logistics Co"
}

Introduction

Conventions