Sign in

REST API

Developers

The Rallybeam REST API lets your own systems create meets and read them back. It acts as you, with the role you have in your company, and does what you can do in the app.

Open the API reference

Before you start

Sign in to Rallybeam and open Settings, then Integrations. It shows your company's client ID and your own client secret, which you can show again or regenerate there.

The secret acts as you. Keep it on your server and never put it in a web page or a mobile app. When you leave the company, it stops working.

Get an access token

Exchange the client ID and secret for an access token with the standard OAuth 2.0 client credentials grant.

curl -X POST https://app.rallybeam.com/v1/oauth/token \
  -d grant_type=client_credentials \
  -d client_id=$CLIENT_ID \
  -d client_secret=$CLIENT_SECRET

Find what a meet needs

Send the token as a bearer token. In every company address, the tenant ID is your client ID. A meet belongs to a position, uses a configuration (the default comes first) and has one or two interviewers from your team.

curl -H "Authorization: Bearer $TOKEN" https://app.rallybeam.com/v1/tenants/$CLIENT_ID/positions
curl -H "Authorization: Bearer $TOKEN" https://app.rallybeam.com/v1/tenants/$CLIENT_ID/configurations
curl -H "Authorization: Bearer $TOKEN" https://app.rallybeam.com/v1/tenants/$CLIENT_ID/members

Create a meet

Create the meet with the position, the configuration, a title, the candidate and the interviewers.

curl -X POST https://app.rallybeam.com/v1/tenants/$CLIENT_ID/meets \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "positionId": "<position id>",
    "configurationId": "<configuration id>",
    "title": "Backend interview",
    "candidateEmail": "ana@example.com",
    "candidateFirstName": "Ana",
    "candidateLastName": "Jovanović",
    "interviewerIds": ["<your user id>"]
  }'

Send the link

The response has the meet's code and the candidate's own code. The meet's link is https://app.rallybeam.com/{code}. The candidate opens it and enters with their code.

Errors come back as problem details whose title is a stable code, such as invalid_title. Anything your role may not see answers 404. The API reference lists every endpoint, request and response, and you can try them there with your own client ID and secret.

Open the API reference · OpenAPI document

Image preview