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.

FieldTypeRequiredDescription
tokenstring (uuid)if no headerYour permanent API token. Required unless you send a user token in the token header.
group_idstring (uuid)yesThe 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.

FieldTypeDescription
source_idstring (uuid)The identifier of the source.
group_idstring (uuid)The group the source belongs to.
createdstring (date-time)When the source was created.
namestringThe name of the source.
auto_person_createobjectWhen the source creates person records by itself. Just { "new_person_threshold": "never" } when it does not.
feature_checkarray of stringThe features recognized on every image the source sends. Empty when there are none.
search_listsarray of objectThe 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 has status of error and a details list 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": []
  }
]

Questions about the face API?

Write to us and we will help.

Talk to us