Regions

Get regions

Gets regions for a project.

GET
/organizations/{organizationId}/projects/{projectId}/regions
x-api-key<token>

In: header

Path Parameters

organizationIdstring
Formatuuid
projectIdstring
Formatuuid

Query Parameters

name?string
Lengthlength <= 256
regionCountry?string
Lengthlength <= 2
regionSubDivision?string
Lengthlength <= 6
consentMode?string
Lengthlength <= 16
blockingMode?|string
enableDoNotSell?boolean
enableGpc?boolean
sort?string
order?string
offset?integer
Default0
Range0 <= value
limit?integer
Default100
Range1 <= value <= 1000

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.concord.tech/privacy-v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/regions"
{
  "offset": 0,
  "count": 0,
  "total": 0,
  "items": [
    {
      "name": "string",
      "regions": "default",
      "customScript": "string",
      "settings": {
        "branding": {
          "buttonRadius": "6px",
          "cardRadius": "6px",
          "font": "Arial",
          "logoUrl": "string",
          "primaryColor": "string",
          "secondaryColor": "string",
          "poweredByConcord": true
        },
        "consent": {
          "blockingMode": "disabled",
          "consentMode": "implied",
          "privacyMode": [
            null
          ],
          "consentBanner": {
            "enabled": true,
            "layout": "bar",
            "position": [
              null
            ],
            "policy": {},
            "title": true,
            "theme": "brand",
            "closeButton": true,
            "denyButton": [
              null
            ],
            "customizeButton": true,
            "showGooglePrivacyPolicy": false
          },
          "hideUnusedCategories": false,
          "doNotSell": true,
          "consentDuration": 6,
          "gcm": "disabled",
          "gcmPolicy": "https://business.safety.google/privacy",
          "gpc": false,
          "impliedConsentDelay": 0,
          "limitPii": false,
          "microsoftUET": "disabled",
          "webflow": true,
          "wordpress": true,
          "tcfConfig": {
            "enabled": true,
            "mode": "disabled",
            "selectedVendors": [
              {
                "vendorId": 0,
                "name": "string",
                "framework": "IAB",
                "addedAt": 0,
                "purposes": [
                  0
                ],
                "flexiblePurposes": [
                  0
                ],
                "specialPurposes": [
                  0
                ],
                "specialFeatures": [
                  0
                ],
                "features": [
                  0
                ],
                "legIntPurposes": [
                  0
                ],
                "policyUrl": "http://example.com",
                "cookieMaxAgeSeconds": 0,
                "cookieRefresh": true,
                "usesNonCookieAccess": true,
                "deviceStorageDisclosureUrl": "http://example.com",
                "dataRetention": {
                  "stdRetention": 0,
                  "purposes": {},
                  "specialPurposes": {}
                },
                "dataDeclaration": [],
                "urls": [
                  {
                    "privacy": "http://example.com",
                    "legIntClaim": "http://example.com"
                  }
                ]
              }
            ],
            "publisherCC": "string",
            "specialPurposeOneTreatment": true,
            "legitimateInterestEnabled": true,
            "selectedStacks": [
              {
                "stackId": 0,
                "addedAt": 0,
                "legalBasis": "consent"
              }
            ]
          }
        },
        "crossSiteTracking": false,
        "crossDeviceConsent": false,
        "floatingButton": {
          "enabled": true,
          "circleOffsetX": "24px",
          "circleOffsetY": "24px",
          "tabOffsetY": "256px",
          "position": "right",
          "theme": "brand",
          "type": "circle",
          "icon": "cookie"
        },
        "placeholders": {
          "enabled": true,
          "theme": "brand"
        },
        "privacyCenter": {
          "consentHistory": true,
          "consentHistoryMode": "legacy",
          "disclosures": true,
          "dsrFormMode": "single",
          "privacyRequests": true,
          "doNotSellRequests": true,
          "position": "right",
          "theme": "brand",
          "vendors": true
        }
      },
      "language": {
        "enabled": false,
        "defaultLanguage": "en_US"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "dateCreated": 0,
      "dateUpdated": 0,
      "slug": "string"
    }
  ]
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "string"
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Forbidden"
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden"
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Not Found"
}
{
  "statusCode": 422,
  "error": "Unprocessable Entity",
  "message": "string"
}
{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "Internal Server Error"
}