Profiles
List profiles
Newest first.
GET
/v1/profilesTL;DR
| Question | Answer |
|---|---|
| What does it do? | List profiles. |
| What does it need? | An API key or an OAuth access token. |
| What does it take? | limit, startingAfter, externalId in the query string. |
| What does it return? | Status 200 with a body of type ProfileList. |
| In the SDK? | flung.profiles.list() |
| As an MCP tool? | list_profiles |
| What can go wrong? | 401 Missing, unknown, revoked or expired API key; 422 The request failed validation; 429 Too many requests for this credential; wait for retry-after seconds. Every failure has the same error shape. |
What it does
Newest first. Pass externalId to find the profile of one of your customers.
Example
curl
curl -X GET 'https://api.flung.dev/v1/profiles?externalId=user_8412' \ --header "Authorization: Bearer $FLUNG_API_KEY"ts
import { Flung } from '@flung.dev/sdk'
const flung = new Flung({ apiKey: process.env.FLUNG_API_KEY! })const result = await flung.profiles.list({ externalId: 'user_8412',})js
const response = await fetch('https://api.flung.dev/v1/profiles?externalId=user_8412', { method: 'GET', headers: { 'Authorization': `Bearer ${process.env.FLUNG_API_KEY}`, },})if (!response.ok) throw new Error((await response.json()).error.message)const result = await response.json()A successful answer looks like this:
json
{ "data": [ { "id": "prof_aaaaaaaaaaaaaaaaaaaaaaaa", "name": "string", "externalId": "string", "createdAt": "2026-11-01T09:00:00.000Z", "updatedAt": "2026-11-01T09:00:00.000Z" } ], "hasMore": true}Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
limit | integer | no | |
startingAfter | string | no | The id of the last profile of the previous page. |
externalId | string | no | Only the profile with this external id. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | A page of profiles. | ProfileList |
| 401 | Missing, unknown, revoked or expired API key. | Error |
| 422 | The request failed validation. | Error |
| 429 | Too many requests for this credential; wait for retry-after seconds. | Error |
Response body
A 200 answer has the type ProfileList.
| Field | Type | Required | Description |
|---|---|---|---|
data | Profile[] | yes | |
data[].id | string | yes | |
data[].name | string | yes | |
data[].externalId | string | null | yes | |
data[].createdAt | string | yes | |
data[].updatedAt | string | yes | |
hasMore | boolean | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint |
| Schemas | Every request and response type |
| Errors | Every error code and what to do about it |
list_profiles | The same operation as an MCP tool |