Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.proconvey.co.uk/llms.txt

Use this file to discover all available pages before exploring further.

Our API uses bearer token authentication to secure your requests.

​
Bearer Token Authentication

Bearer tokens provide a straightforward way to authenticate API requests. Include your token in the Authorization header of each request.

​
Getting your bearer token

  1. Log into your dashboard
  2. Navigate to Settings > Integrations
  3. Generate a new API key
  4. Copy and securely store your token
Keep your API keys secure and never expose them in client-side code or public repositories.

​
Using bearer tokens

Include your bearer token in the Authorization header: 
curl -X GET 'https://yourorg.proconvey.co.uk/api/v2/cases' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

​
Error handling

Common authentication errors and how to handle them:
Cause: Invalid or missing authentication credentialsSolution: Verify your API key is correct and included in the Authorization header
Cause: Valid credentials but insufficient permissionsSolution: Check that your API key has the required scopes for the endpoint

​
Best practices

  • Store API keys securely using environment variables or a secrets manager
  • Use the minimum required scopes for your integration
  • Regularly rotate your API keys
  • Never expose keys in client-side code or version control

​
Testing authentication

You can test your authentication setup by making a request to the organisation endpoint: 
curl -X GET 'https://yourorg.proconvey.co.uk/api/v2/org' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
A successful response confirms your authentication is working and returns your organisation details.