Skip to main content
GET
/
v1
/
profiles
List Profiles
curl --request GET \
  --url https://api.bctrl.ai/v1/profiles \
  --header 'Authorization: Bearer <token>'
{
  "profiles": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>"
    }
  ]
}
​
kind
string
Filter by profile kind.
​
name
string
Filter by name.

​
Examples

import { Bctrl } from '@bctrl/sdk';
const bctrl = new Bctrl({ apiKey: process.env.BCTRL_API_KEY! });

const result = await bctrl.profiles.list();

​
Response

​
profiles
array
required
Array of profile objects.