RecVue APIs use token-based authentication. Exchange the credentials of a RecVue user for an access token, then send that token in the access_token header on every API call.
Use a dedicated integration user. Create a separate user in your tenant for each integration and assign it only the roles it needs. API access follows that user's role permissions.
Base URL
| Environment | Base URL |
|---|---|
| Production | https://{tenant}.recvue.com/api |
| Test / Sandbox | https://{tenant}-test.recvue.com/api |
{tenant} is your company short name, e.g. acme. The host name identifies your tenant, so you don't need to send a tenant header.
Step 1: Get an access token
Send a GET request to the token endpoint with your username and password, base64-encoded as username:password, in the Authorization header.
curl -X GET "https://{tenant}.recvue.com/api/v2.0/token" \
-H "Authorization: $(printf '%s' '[email protected]:YourPassword' | base64)"Response (200)
{
"access_token": "eyJraWQiOiJ...",
"expiration_date": "Tue Nov 04 10:15:00 UTC 2026"
}| Field | Description |
|---|---|
access_token | Token to send on every API request. |
expiration_date | When the token expires (UTC). Tokens are valid for about 1 hour. |
The token endpoint is the same for every API version. Always request tokens from
/api/v2.0/token, including when you call v2.1 or v3.0 endpoints. There is no/api/v2.1/tokenor/api/v3.0/token.
Step 2: Call the API
Send the token in the access_token header. Don't add a Bearer prefix.
curl -X GET "https://{tenant}.recvue.com/api/v3.0/orders?page=1&size=10" \
-H "access_token: eyJraWQiOiJ..." \
-H "Content-Type: application/json"Token lifetime and renewal
- Tokens expire after about 1 hour. Check
expiration_date. - No refresh token is issued. Request a new token from the token endpoint before the current one expires.
Errors
| Status | When | Body |
|---|---|---|
401 Unauthorized | Missing or malformed Authorization header, invalid username or password, or a locked or inactive user | {"error": "<message>"} |
401 Unauthorized | Missing, invalid or expired access_token on an API call | Gateway error response |
Check
statusCodein the response body. Some endpoints return HTTP200for business or validation failures and put the failure status in the body.
SCIM provisioning authentication
The SCIM 2.0 user provisioning APIs (/api/scim/Users) use a separate OAuth 2.0 client credentials flow. Contact RecVue Support to get a client_id and client_secret for your tenant.
Get a SCIM token
curl -X POST "https://{tenant}.recvue.com/api/scim/oauth/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=YOUR_CLIENT_ID" \
-d "client_secret=YOUR_CLIENT_SECRET"Alternatively, send the client ID and secret as an HTTP Basic header (Authorization: Basic base64(client_id:client_secret)) with only grant_type=client_credentials in the body.
Response (200)
{
"access_token": "eyJhbGciOi...",
"token_type": "Bearer",
"expires_in": 3600
}Call SCIM endpoints with the token as a Bearer token:
curl -X GET "https://{tenant}.recvue.com/api/scim/Users?startIndex=1&count=10" \
-H "Authorization: Bearer eyJhbGciOi..."| RecVue APIs | SCIM APIs | |
|---|---|---|
| Token endpoint | GET /api/v2.0/token | POST /api/scim/oauth/token |
| Credentials | Username and password | Client ID and secret |
| Header on calls | access_token: <token> | Authorization: Bearer <token> |
| Lifetime | About 1 hour | expires_in seconds (default 3600) |
