Follow an entity
Give a district or school standing attention within a project. On the free tier, following also lights up the entity's paid layers. Refused with `FOLLOW_LIMIT` when all free slots are in use.
Give a district or school standing attention within a project. On the free tier, following also lights up the entity's paid layers. Refused with FOLLOW_LIMIT when all free slots are in use.
API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...
In: header
Request Body
application/json
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuid"district" | "school"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidResponse Body
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/follows" \ -H "Content-Type: application/json" \ -d '{ "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "entity_type": "district", "entity_id": "8161163a-f227-466f-bc01-090a01e80165" }'{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"project_id": "550e8400-e29b-41d4-a716-446655440000",
"entity_type": "district",
"entity_id": "550e8400-e29b-41d4-a716-446655440000",
"followed_at": "string",
"unfollowed_at": "string",
"slot_released_at": "string",
"created_at": "string"
}
}{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"project_id": "550e8400-e29b-41d4-a716-446655440000",
"entity_type": "district",
"entity_id": "550e8400-e29b-41d4-a716-446655440000",
"followed_at": "string",
"unfollowed_at": "string",
"slot_released_at": "string",
"created_at": "string"
}
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}{
"error": "string",
"message": "string",
"slots": {
"used": -9007199254740991,
"limit": -9007199254740991,
"tier": "string"
}
}List follows for a project GET
Active follows for a project plus a slots summary. Follows are project-scoped; free orgs have 5 slots (an unfollowed slot stays occupied for 14 days), enterprise/internal are unlimited (`limit: null`).
Unfollow DELETE
Records the unfollow (history is preserved). The slot returns after 14 days, or immediately when unfollowing within 24 hours of the follow.