role relay

GCA CMP Developer Portal

APIs that power candidate management across Africa and beyond โ€” a stable, versioned contract you can build against today. Pick an environment in the reference and start integrating.

Explore the API โ†’ OpenAPI spec

Environments

The same contract, per environment. Your API key is scoped to one of them.

EnvironmentBase URLFor
Developmenthttps://api.dev.gca.rolerelay.comIntegration & testing
Productionhttps://api.gca.rolerelay.comLive traffic (coming)

Quick start

Every /v1 request carries an X-API-Key. Create a candidate:

# against Development
curl -X POST https://api.dev.gca.rolerelay.com/v1/candidates \
  -H "X-API-Key: <your-key>" \
  -H "Content-Type: application/json" \
  -d @candidate.json

Open the reference, pick Development in the server dropdown, and use Try it to send a live request.

Guides

Authentication
X-API-Key, scoped per org & environment.
Versioning
Backward-compatible within /v1.
Webhooks
Signed candidate-lifecycle events to your endpoint.
SDK
Generate a client from the OpenAPI spec.