REST API: data sources
List data sources in a group
Read the data sources of a group.
Purpose
Use this call to list the sources of a group together with the recognition settings each one carries.
Request
POST <API_BASE_URL>/sources. All calls are POST under your API address. Replace <API_BASE_URL> with the API address provided with your access.
Send a permanent API token in the token field of the body, or a user token in the token header. See authentication.
Content type: application/json.
| Field | Type | Required | Description |
|---|---|---|---|
token | string (uuid) | if no header | Your permanent API token. Required unless you send a user token in the token header. |
group_id | string (uuid) | yes | The group whose sources are returned. |
Response
HTTP 200. Every source of the group, sent as a bare array. This operation does not wrap its success in the status envelope.
| Field | Type | Description |
|---|---|---|
source_id | string (uuid) | The identifier of the source. |
group_id | string (uuid) | The group the source belongs to. |
created | string (date-time) | When the source was created. |
name | string | The name of the source. |
auto_person_create | object | When the source creates person records by itself. Just { "new_person_threshold": "never" } when it does not. |
feature_check | array of string | The features recognized on every image the source sends. Empty when there are none. |
search_lists | array of object | The person lists every image of the source is searched against, with the callbacks fired on the outcome. |
Errors
400: The body failed validation. The answer hasstatusoferrorand adetailslist with one entry per offending field (path,expected,actual).401: The token is missing, expired or unknown.
A refusal can also come before the operation runs: an address outside your IP allowlist, a token bound to another address, or a body that is not valid JSON. See response format and errors.
Example
Request:
curl -X POST "<API_BASE_URL>/sources" \
-H "Content-Type: application/json" \
-d '{
"token": "<your permanent API token>",
"group_id": "<group id>"
}'
Response:
[
{
"source_id": "<source id>",
"group_id": "<group id>",
"created": "2026-01-01T10:00:00.000Z",
"name": "Front door",
"auto_person_create": {
"new_person_threshold": "never"
},
"feature_check": [],
"search_lists": []
}
]