Profiles

Profiles

Retrieving profile list

get

Returns many profiles.

Authorizations

tokenAuthBearer

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

401

Authentication credentials were missing or invalid.

get

/api/v2/profiles/

HTTPcURLJavaScriptPython

GET /api/v2/profiles/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "isDefault": true
    }
  ]
}

Retrieving profile by ID

get

Returns a single profile.

Authorizations

tokenAuthBearer

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstring · uuidRequired

A UUID string identifying this run profile.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

namestring · max: 128Required

isDefaultbooleanOptional

401

Authentication credentials were missing or invalid.

404

Resource not found.

get

/api/v2/profiles/{id}/

HTTPcURLJavaScriptPython

GET /api/v2/profiles/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDefault": true
}