Integrations › List the integrations

Integrations

List the integrations

GET/api/{ORG}/integrationsPermalink

The organisation’s integrations, oldest first, with this billing period’s deliveries. Their deliveries are GET /integrations/deliveries.

Permission
Integrations · view
Plan
Plans that include the API: Pricing
Retry
Safe: a read changes nothing

Example request

bash
curl "https://console.brevily.com/api/NORTHWIND/integrations" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
[  {    "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "kind": "WEBHOOK",    "url": "https://www.example.com/sale/autumn",    "measurementId": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "platform": "META",    "pixelId": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "linkId": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "folder": "example",    "events": [      "link.click"    ],    "status": "ACTIVE",    "activeSince": "2026-11-05T09:41:00Z",    "sent": 1,    "failed": 0,    "lastSentOn": "2026-11-05T09:41:00Z",    "createdOn": "2026-11-05T09:41:00Z"  }]

Made-up values.

PathPermalink

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters

QueryPermalink

Query parameters
NameTypeRequiredDescriptionAllowed values
statusstringoptionalNarrows the answer: ?status=<value>, or ?status=eq:<value>.—
beforestringoptionalNarrows the answer: ?before=<value>, or ?before=eq:<value>.—
afterstringoptionalNarrows the answer: ?after=<value>, or ?after=eq:<value>.—
addstringoptionalNarrows the answer: ?add=<value>, or ?add=eq:<value>.—
eventsstringoptionalNarrows the answer: ?events=<value>, or ?events=eq:<value>.—
folderstringoptionalNarrows the answer: ?folder=<value>, or ?folder=eq:<value>.—
qstringoptionalA search term.—

AnswerPermalink

A list of Integration, one page at a time: paging.

Answer fields
NameTypeDescriptionAllowed values
idstringThe integration’s id.—
kindstringA signed webhook, GA4 forwarding (Measurement Protocol), or an ad pixel the links that name it fire in the visitor’s browser.WEBHOOK, GA4, PIXEL
urlstringA webhook’s https address; null for every other kind.or null
measurementIdstringA GA4 stream’s measurement id; null for every other kind.or null
platformstringAn ad pixel’s ad network; null for every other kind.META, LINKEDIN, X, GOOGLE_ADS, MICROSOFT_ADS, PINTEREST; or null
pixelIdstringAn ad pixel’s id at its ad network (Google Ads: its conversion id, AW-…); null for every other kind.or null
linkIdstringThe one link it sends; null for every link (and for a pixel, which the links that name it fire).or null
folderstringThe code of the one folder it sends the links of (those in it now: a link moved out stops matching, one moved in starts); null for every link or one link.or null
eventsstring[]What it receives: a webhook’s choice (link.click when none was chosen), GA4’s link.click alone, a pixel’s nothing.link.click, link.created, link.updated, link.expired, link.broken, event.reported
statusstringDISABLED queues nothing; turning one off gives up what it still owed.ACTIVE, DISABLED
activeSincedate-timeClicks from then on are sent (when it was made or last turned on).or null
sentintegerDeliveries sent this billing period.—
failedintegerDeliveries given up this billing period.—
lastSentOndate-timeIts last delivery sent this billing period; null for none.or null
createdOndate-timeWhen it was made.—

ErrorsPermalink

Errors
Status Code When
400 VALIDATION_FAILED A field, a parameter or the body is wrong; details.fields says which.
401 UNAUTHENTICATED No key, a key that does not match, or one expired or revoked.
403 ACCESS_DENIED The key lacks Integrations · view, or the organisation’s plan does not include it.
404 NOT_FOUND No organisation with that code for this key, or no such record in it.
429 RATE_LIMITED Too many calls: wait Retry-After seconds.

Rate limitsPermalink

Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.