API referenceCollections
Describe a collection
Returns the collection with its face/selfie counts, from the gateway's count registry (or a live engine read when the registry… (GET /v1/collections/{id})
Last updated
GET
/v1/collections/{id}- Auth
- Bearer API key
- Billing
- free (0 credits).
Returns the collection with its face/selfie counts, from the gateway's count registry (or a live engine read when the registry is not ready, or with ?verify=true). Free.
Example request
curl -X GET "https://api.sightradar.com/v1/collections/$ID" \
-H "Authorization: Bearer $SR_API_KEY"Put each id in the path percent-encoded, as a single path segment. An id with /, ?, #, % or a space otherwise addresses a different URL. In code, use your HTTP library's path encoding (for example encodeURIComponent in JavaScript or urllib.parse.quote(id, safe="") in Python).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id required | path | string | Collection id. |
verify | query | boolean | Force a live engine read of the counts instead of the gateway registry (counts_source becomes engine). |
Response body
| Field | Type | Description |
|---|---|---|
collection_id | string | |
status | "active" | "deletion_pending" | "deleting" | "deleted" | |
counts_source | string | Where the counts came from: postgres = the gateway's count registry (the normal case), engine = a live read from the engine (a collection whose registry counts are not ready yet, or ?verify=true). |
photo_count | integer | |
face_count | integer | |
selfie_count | integer | |
created_at | string | |
purge_after | string | Present on deletion_pending collections: when the soft delete becomes permanent. |
Status codes
| Status | Meaning |
|---|---|
200 | Collection detail. |
400 | The collection id is ".", "..", or contains '/', '' or a control character. Same message as create. |
401 | Missing or invalid API key. |
404 | Resource not found. |