Representatives

Explains APIs available to interact with Representative objects in Score.

List representatives

get

This endpoint will list representatives. Pagination is supported using limit and offset query parameters.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · int32 · max: 50Optional

The number of representatives to return. Defaults to 10. Max is 50.

Default: 10

offsetinteger · int32Optional

The number of representatives to skip in pagination. Defaults to 0.

Default: 0

Responses

200

The request has succeeded.

application/json

get

/api/v1/representatives

HTTPcURLJavaScriptPython

GET /api/v1/representatives HTTP/1.1
Host: api.usescore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The request has succeeded.

{
  "data": [
    {
      "id": "text",
      "username": "text",
      "name": "text",
      "createdAt": "2025-12-11T02:04:54.432Z"
    }
  ]
}

Add representative

post

Add a representative to a team.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

teamIdstringRequired

usernamestringRequired

passwordstringRequired

Responses

200

The request has succeeded.

application/json

post

/api/v1/representatives

HTTPcURLJavaScriptPython

POST /api/v1/representatives HTTP/1.1
Host: api.usescore.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "teamId": "text",
  "username": "text",
  "password": "text",
  "profile": {
    "firstName": "text",
    "lastName": "text"
  }
}

200

The request has succeeded.

{
  "data": {
    "id": "text",
    "username": "text",
    "name": "text",
    "createdAt": "2025-12-11T02:04:54.432Z"
  }
}