Skip to content

List Profiles API

The List Profiles API lets you list profiles for this project with a single GET request. Use it to discover the profiles available to your project, page through the results, and narrow the list by profile name before you work with an individual profile.

List Profiles API overview with exact contract GET /v1/profiles/

List profiles for this project by sending a GET request to /v1/profiles/. The trailing slash is part of the path, so keep it unchanged when you build the request URL from your configured base URL. This operation is read-only: it returns a paginated collection rather than creating or modifying a profile.

Authorization: x-access-key header

Every request must include the access key in the x-access-key header. Send the token as the header value, for example x-access-key: <token>, where <token> is your access key placeholder. Check that the header name is spelled exactly x-access-key and that the value is the token you intend to send before changing any other part of the request.

Query Parameters input contract: page, limit, name

All three query parameters are optional. The page parameter selects which page of results to return and defaults to 1, with a minimum value of 1. The limit parameter controls how many profiles are returned per page and defaults to 50, with values from 1 to 100. The name parameter filters by profile name using a case-insensitive substring match, so a partial name matches profiles whose names contain that text regardless of letter case, and its length must be between 1 and 200 characters. When you paginate, keep page and limit consistent across calls and use the total value in the response to decide whether more pages remain. When you filter by name, remember that the match is a substring match, not an exact match, so short fragments can return more profiles than you expect.

Response Body field map for 200 application/json

A successful call returns status 200 with an application/json body. The top-level success field is a boolean indicating whether the request succeeded. The total field is an integer greater than or equal to 0 and reports how many profiles match the request in total. The page and limit fields echo the pagination values used for the response, each an integer greater than or equal to 1. The profiles field is an array of profile objects. Each profile object contains id as a string, name as a string, description as a string or null, integrationCount as an integer greater than or equal to 0 representing the number of active integrations bound to the profile, and createdAt and updatedAt as strings in date-time format. Parse description as nullable, and do not assume it is always a string.

Origin-modular request example and response example

Build the request by combining your configured base URL with the unchanged path /v1/profiles/, adding the x-access-key header, and appending any of page, limit, or name as query parameters. The request example below shows the minimal call with no query parameters, which uses the documented defaults. The response example below shows the shape of a 200 response, including the profiles array and the fields inside each profile object. Use these examples as the parsing reference for your client: read success first, then total, page, and limit for pagination, then iterate profiles and read id, name, description, integrationCount, createdAt, and updatedAt from each entry.

Query parameters input contract
ParameterLocationTypeRequiredDefaultConstraintsDescription
pagequeryintegerNo11 <= value
limitqueryintegerNo501 <= value <= 100
namequerystringNo—1 <= length <= 200Case-insensitive substring match on profile name

Exact captured contract; all parameters optional.

200 response body field map
FieldTypeRequiredConstraints / FormatDescription
successbooleanYes—
totalintegerYes0 <= value
pageintegerYes1 <= value
limitintegerYes1 <= value
profilesarray<object>Yes—
profiles[].idstringYes—
profiles[].namestringYes—
profiles[].descriptionstring | nullYes—
profiles[].integrationCountintegerYes0 <= valueNumber of active integrations bound to this profile
profiles[].createdAtstringYesdate-time
profiles[].updatedAtstringYesdate-time

Exact captured contract for 200 application/json.

List profiles request example
curl -X GET "{{API_BASE_URL}}/v1/profiles/" -H "x-access-key: <token>"
200 response example
{
  "success": true,
  "total": 0,
  "page": 1,
  "limit": 1,
  "profiles": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "integrationCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
Interface fields
ScopeFieldTypeType referenceRequiredDescriptionConstraints
page#1pageinteger__0Nokind: schemaDefault; value: 1 | kind: schemaRange; value: 1 <= value
limit#2limitinteger__0Nokind: schemaDefault; value: 50 | kind: schemaRange; value: 1 <= value <= 100
name#3namestring__0NoCase-insensitive substring match on profile namekind: schemaLength; value: 1 <= length <= 200
response#4responseobject__0
response#4response.successboolean__1Yes
response#4response.totalinteger__2Yeskind: schemaRange; value: 0 <= value
response#4response.pageinteger__3Yeskind: schemaRange; value: 1 <= value
response#4response.limitinteger__4Yeskind: schemaRange; value: 1 <= value
response#4response.profilesarray<object>__5Yes
response#4response.profiles[]object__6
response#4response.profiles[].idstring__7Yes
response#4response.profiles[].namestring__8Yes
response#4response.profiles[].descriptionstring | null__9Yes
response#4response.profiles[].description[variant1]string__9_type:string
response#4response.profiles[].description[variant2]null__9_type:null
response#4response.profiles[].integrationCountinteger__10YesNumber of active integrations bound to this profilekind: schemaRange; value: 0 <= value
response#4response.profiles[].createdAtstring__11Yeskind: schemaFormat; value: date-time
response#4response.profiles[].updatedAtstring__12Yeskind: schemaFormat; value: date-time