Skip to main content
Not a developer? Get general product support via our knowledge base.
The Ropes API lets you programmatically manage candidates, screenings, problems, results, and other resources in your Ropes organization. The API follows REST conventions, accepts JSON request bodies, and returns JSON responses. All production requests must use HTTPS. Ropes follows standard API conventions and is committed to only shipping non-breaking changes to our public APIs. Net-new endpoints or response fields are not considered breaking according to standard conventions. If a breaking change becomes necessary, Ropes will identify all consumes and proactively notify them so application logic can be adjusted.

​
Base URL

Send API requests to:
For example, the endpoint for listing candidates is:

​
Authentication

The Ropes API uses API keys for authentication. Include your API key in the x-api-key header with every request:
Keep API keys secure. Never expose them in client-side code, public repositories, browser requests, or application logs.

​
Create an API Key

You need permission to manage integrations for your Ropes organization.
  1. Sign in to your Ropes account.
  2. Open Settings.
  3. Under Integrations, select API.
  4. Click Generate New API Key.
  5. Optionally, enter a descriptive name such as Production API or Reporting Integration.
  6. Select desired expiration window and scopes. Ropes recommends rotating API keys at least every quarter as best practice. We also recommend provisioning keys with the narrowest set of scopes given your system requirements.
  7. Click Generate, then copy the key and store it securely. You’ll only be shown the key once. Ropes does not store the key, so any lost keys must be revoked and recreated.
Use separate API keys for different applications and environments. This makes individual integrations easier to identify and revoke. To revoke a key:
  1. Find the key you want to revoke.
  2. Open its actions menu.
  3. Select Delete API Key.
  4. Confirm the deletion.
Revocation takes effect immediately and cannot be undone. Update the affected integration with a replacement key before deleting a key that is currently in use.

​
Response Codes

Ropes uses standard HTTP status codes to indicate whether a request succeeded.