Profiles API

You can use the Profiles API to programmatically run your Profiles project and check its run status.

Prerequisites

• Set up a Profiles project in the RudderStack dashboard. Then, note down the Profiles project ID from the URL:

• Generate a workspace-level Service Access Token in the RudderStack dashboard with the following permissions to authenticate the API:

Token permissions for legacy RBAC system

If you are on the legacy Permissions Management (RBAC) system, your workspace-level Service Access Token should have minimum Editor permissions.

See this documentation for more information on generating the token.

Authentication

The Profiles API uses Bearer authentication in the following format:

Authorization: Bearer <SERVICE_ACCESS_TOKEN>

Base URL

Use the base URL for your API requests depending on your region:

https://api.rudderstack.com/v2

https://api.eu.rudderstack.com/v2

Run project

You can trigger the run of a Profiles project using the below endpoint:

To obtain the

Path parameters

Request body

Example request

POST /v2/sources/<profilesID>/start HTTP/1.1
Host: api.rudderstack.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>

{
  "parameters": ["--model_refs models/id_graph_users"]
}

curl --location 'https://api.rudderstack.com/v2/sources/<profilesID>/start' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
  "parameters": ["--model_refs models/id_graph_users"]
}'

Example response

{
  "runId": "<run_id>"
}

Response codes

Get run status

You can get the run status of your Profiles project using the below endpoint:

Path parameters

You can obtain the runId as the response of the above API endpoint (/sources/<profilesID>/start).

Example request

GET /v2/sources/<profilesID>/runs/{run_id}/status HTTP/1.1
Host: api.rudderstack.com
Accept: application/json
Authorization: Bearer <token>

curl --location 'https://api.rudderstack.com/v2/sources/<profilesID>/runs/<run_id>/status' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Example response

{
  "jobId": "string",
  "jobRunId": "string",
  "status": "string",
  "startedAt": "2024-05-31T06:48:08.228Z",
  "finishedAt": "2024-05-31T06:48:08.228Z",
  "tasks": [{
    "taskId": "string",
    "taskRunId": "string",
    "startedAt": "2024-05-31T06:48:08.228Z",
    "finishedAt": "2024-05-31T06:48:08.228Z"
  }]
}

Response codes