Skip to main content
GET
/
entities
/
{id}
/
country-activations
List entity country activations
curl --request GET \
  --url http://api.gu1.ai/entities/{id}/country-activations \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data.entityId": "<string>",
  "data.countries": [
    {}
  ]
}

​
Overview

Returns the operational country activation state for a merchant entity. This is an operational flag only — it does not change entity data, enrichments, or compliance status. Integrators typically re-fetch the full entity after receiving the entity.country_activation_changed webhook. Supported countries (v1): AR, BR, CL, CO, MX, US. When no row exists for a country, the API returns deactivated (opt-in model).

​
Endpoint

GET http://api.gu1.ai/entities/{id}/country-activations

​
Authentication

Requires entities:read (legacy fallback: entities:read / viewer role). 
Authorization: Bearer YOUR_API_KEY

​
Path Parameters

​
id
string
required
UUID of the entity (merchant).

​
Response

​
success
boolean
Whether the request succeeded.
​
data.entityId
string
Entity UUID.
​
data.countries
array
Fixed list of six countries with activation metadata.
Each item in data.countries:
FieldTypeDescription
countryCodestringISO 3166-1 alpha-2 (AR, BR, CL, CO, MX, US)
statusstringdeactivated, activation_requested, activation_in_progress, or activated
activatedAtstring | nullISO timestamp when last reached activated
deactivatedAtstring | nullISO timestamp when last reached deactivated
updatedAtstring | nullISO timestamp of last status change (null if never set)

​
Example

curl -X GET "https://api.gu1.ai/entities/550e8400-e29b-41d4-a716-446655440000/country-activations" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": {
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "countries": [
      {
        "countryCode": "AR",
        "status": "deactivated",
        "activatedAt": null,
        "deactivatedAt": null,
        "updatedAt": null
      },
      {
        "countryCode": "CO",
        "status": "activation_in_progress",
        "activatedAt": null,
        "deactivatedAt": null,
        "updatedAt": "2026-07-03T15:00:00.000Z"
      },
      {
        "countryCode": "MX",
        "status": "activated",
        "activatedAt": "2026-07-03T15:00:00.000Z",
        "deactivatedAt": null,
        "updatedAt": "2026-07-03T15:00:00.000Z"
      }
    ]
  }
}

​
Errors

HTTPCodeWhen
404ENTITY_NOT_FOUNDEntity does not exist in the current organization