List Profiles API
The List Profiles API returns active profiles for your project in a paginated list ordered newest-first. Use it to discover which profiles are available before retrieving a single profile or working with the integrations bound to each profile.
Endpoint and scope
This endpoint lists active profiles for your project. Profiles are returned paginated and ordered newest-first, so the most recently created profiles appear first. The scope is active profiles only; deleted profiles are not included in this list.
Request contract
Send a GET request to the profiles path shown in the request example below. Include the x-access-key header with your API key, as shown in that example. Both query parameters are optional: page is a 1-indexed integer that defaults to 1, and limit is an integer page size between 1 and 100 that defaults to 50. If you omit both, you receive the first page with the default page size. To walk through a larger set of active profiles, increment page while keeping limit within its allowed range, and use the total, page, and limit values echoed in the response to confirm which slice you received.
Worked pagination example
The worked example below requests page 1 with a limit of 20. That combination returns up to twenty profiles from the newest-first ordering, starting with the newest profile. Check the failure cases before you rely on the result: a limit outside 1 to 100 is outside the documented contract, and page values are 1-indexed rather than 0-indexed. The only documented status for this endpoint is 200 Success, so do not assume additional error codes from this reference.
Response field map
A successful response contains an envelope with success, total, page, limit, and a profiles array. Each profile object contains id, name, description, integrationCount, createdAt, and updatedAt. The description field can be null, as shown for a profile without a description. The createdAt and updatedAt fields are timestamps for when the profile was created and last updated. Use id to identify a profile in later calls, and use name and description for display and grouping context.
integrationCount semantics and ordering
The integrationCount field is computed from the currently active, non-deleted integrations bound to each profile. It is a count, not a list of integrations, so a profile with integrationCount of 3 has three active integrations bound to it at the time of the response. Because the count reflects current state, it can change as integrations are added, removed, or deleted, even when the profile itself is unchanged. Compare integrationCount across profiles to see which profiles currently have active integrations attached.
Status codes
The documented status code for this endpoint is 200 Success. No other status codes are documented for this operation in this reference, so treat any other outcome as outside the documented contract rather than assuming a specific meaning.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (1-indexed). Defaults to 1. |
| limit | integer | No | Page size, between 1 and 100. Defaults to 50. |
Documented contract; both parameters optional.
| Field | Type / value | Description |
|---|---|---|
| success | boolean | True on success. |
| total | integer | Total number of active profiles matching the list scope. |
| page | integer | Page number returned, echoing the request. |
| limit | integer | Page size returned, echoing the request. |
| profiles | array | Profile objects ordered newest-first. |
| profiles[].id | string | Profile identifier. |
| profiles[].name | string | Profile name. |
| profiles[].description | string or null | Profile description; null when none is set. |
| profiles[].integrationCount | integer | Computed from currently active (non-deleted) integrations bound to the profile. |
| profiles[].createdAt | string (timestamp) | When the profile was created. |
| profiles[].updatedAt | string (timestamp) | When the profile was last updated. |
Field map derived from documented response example.
| Code | Meaning |
|---|---|
| 200 | Success |
Only documented status; no additional codes invented.
Frequently asked questions
What are the defaults for page and limit?
Both are optional. page defaults to 1 and limit defaults to 50, with limit between 1 and 100.
How is integrationCount calculated?
It is computed from currently active (non-deleted) integrations bound to each profile, so it reflects current state rather than a stored static value.
In what order are profiles returned?
Profiles are ordered newest-first, so the most recently created profiles appear first in the profiles array.
curl "{{API_BASE_URL}}/v1/profiles?page=1&limit=20" \
-H "x-access-key: YOUR_API_KEY"GET {{API_BASE_URL}}/v1/profiles{
"success": true,
"total": 2,
"page": 1,
"limit": 20,
"profiles": [
{
"id": "65ab...",
"name": "Acme Co",
"description": "Example post details.",
"integrationCount": 3,
"createdAt": "2026-05-03T08:33:36.445Z",
"updatedAt": "2026-05-03T08:33:36.445Z"
},
{
"id": "65ac...",
"name": "Personal",
"description": null,
"integrationCount": 1,
"createdAt": "2026-05-02T17:11:02.000Z",
"updatedAt": "2026-05-02T17:11:02.000Z"
}
]
}