Get subscription

GET /data/subscriptions/{instance_id}
Jwt authorization

Retrieve a subscription by its ID and return it as a JSON object. Supports including relations.

Path parameters

  • instance_id string(uuid) Required

Query parameters

  • relations boolean

    Whether to include relations

Responses

  • 200 application/json

    Subscription retrieved successfully

    Hide response attributes Show response attributes object
    • id string(uuid)
    • person_id string(uuid)
    • entity_id string(uuid)
    • created_at string(date-time)
    • updated_at string(date-time)
  • 400

    Invalid ID format or query error

GET /data/subscriptions/{instance_id} 
curl \
 --request GET 'http://api.example.com/data/subscriptions/a24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "person_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "entity_id": "c24a6ea4-ce75-4665-a070-57453082c25",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}