Skip to content
Zaraftis API
Esc
↑↓navigate↵open⌘Jpreview

Get a visibility setup

Returns the saved setup with its current immutable version contents: id, optional name, brand id and URL, country, language, selected platforms, creation time, topics ({id, title}), prompts ({id, text, topic_id}), and competitors ({id, name, url}), plus status, setup_checksum, and current_version. Unknown, cross-workspace, allowlist-excluded, and archived IDs all answer the same 404 not_found.

GET/visibility-setups/{setup_id}
Authorization
AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

or
AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Path parameters
setup_idstring<uuid>required
Responses
200

The saved setup with its current immutable version contents

successbooleanrequired
dataSetupObjectrequired
Show properties
idstring<uuid>required
matches ^([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)$
namestring | nullrequired
Show properties
Any of:
string
string
null
null
brandobjectrequired
Show properties
idstring<uuid>required
matches ^([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)$
urlstringrequired
min length 1
countrystringrequired
min length 2 · max length 2
languagestringrequired
min length 2 · max length 10
creation_modestringrequired
Allowed:manualauto
statusstringrequired
Allowed:activearchived
setup_checksumstringrequired
min length 1
current_versionintegerrequired
min 1 · max 9007199254740991
platformsstring[]required
topicsobject[]required
Show properties
Array of object
idstring<uuid>required
matches ^([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)$
titlestringrequired
min length 1
promptsobject[]required
Show properties
Array of object
idstring<uuid> | nullrequired
Show properties
Any of:
string<uuid>
string<uuid>
null
null
textstringrequired
min length 1
topic_idstring<uuid> | nullrequired
Show properties
Any of:
string<uuid>
string<uuid>
null
null
competitorsobject[]required
Show properties
Array of object
idstring<uuid>required
matches ^([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)$
namestringrequired
min length 1
urlstringrequired
min length 1
created_atstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
request_idstringrequired
min length 1
404

not_found: unknown id, or an id this key cannot see

successbooleanrequired
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsobject
field_errorsobject[]
Show properties
Array of object
fieldstringrequired
codestringrequired
Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid
messagestringrequired
request_idRequestIdrequired
Request
curl -X GET 'https://api.zaraftis.com/v1/visibility-setups/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "brand": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "url": "string"
    },
    "country": "st",
    "language": "string",
    "creation_mode": "manual",
    "status": "active",
    "setup_checksum": "string",
    "current_version": 1,
    "platforms": [
      "string"
    ],
    "topics": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "title": "string"
      }
    ],
    "prompts": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "text": "string",
        "topic_id": "646807af-5da6-43aa-83d3-8ac1d15ab4e5"
      }
    ],
    "competitors": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "url": "string"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z"
  },
  "request_id": "string"
}

Was this page helpful?