cohorts

Get a cohort

Returns cohort metadata and counts. It never enumerates or reveals stored identities - the identities you uploaded are encrypted at rest and are not readable back through the API.

get/cohorts/{cohortId}

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/cohorts/{cohortId}
  • Auth: API key in header x-api-key

Path parameters

cohortIdstring required
Example:4MRtBDNO0stwfon8emOHT

Cohort identifier returned by POST /v1/cohorts.

Response

Cohort metadata

cachedboolean
credits_remaininginteger nullable
credits_usedinteger
endpointstring
platformstring
request_idstring
successboolean

Example response

{
  "data": {
    "retention_days": 30
  },
  "platform": "cohorts",
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.