Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/tags

List all tags

This API retrieves all tags associated with the authenticated account. Tags serve as labels that help organize and filter locations.

Response Includes:

  • Tag ID (Unique identifier)
  • Tag Name (Label used for categorization)
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Request

Request
curl -X GET 'https://api.synup.com/api/v4/tags' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successfully retrieved list of tags
401Unauthorized - Authentication credentials are missing or invalid
403Forbidden - User doesn't have permission to access tags
500Internal server error
Example response
{
  "data": {
    "listAllTags": [
      {
        "id": "2baeca0a-f8df-4971-9c2b-dd5013bdddb3",
        "name": "13january22"
      },
      {
        "id": "5a7f936d-83a0-4181-87b5-947f893f391b",
        "name": "13janunapproved"
      },
      {
        "id": "0dd48e87-4e50-4a40-90eb-1db60030885b",
        "name": "15dec22"
      },
      {
        "id": "0a6e6012-405a-4533-92d0-a75e7f9d4faa",
        "name": "18jan"
      },
      {
        "id": "e7cea330-5a50-4bcf-a591-828c108e89c4",
        "name": "19apr"
      }
    ]
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.listAllTagsarray of objectoptionalArray of tag objects
data.listAllTags[].idstringrequiredUnique identifier for the tag
data.listAllTags[].namestringrequiredDisplay name of the tag