Skip to content

List integrations

GET
https://api.getsitecontrol.com/v1/sites/{site_id}/integrations
curl --request GET \
--url 'https://api.getsitecontrol.com/v1/sites/1/integrations?failures_days=7&limit=50' \
--header 'Authorization: Bearer <token>'

Integrations of the site: connected services, webhooks and Zapier, each with its widget, whether it is on now (is_active) and how many of its recent deliveries failed (failures). The starting point when form responses do not arrive somewhere: find the integration here, with has_failures=true for the failing ones, then read its setup with get_integration, its counts with get_integration_stats and its records with list_integration_deliveries. These operations only read: none of them resends, retries or tests a delivery.

Filters combine: every one given must match. Ordered by kind (service, webhook, zapier), then by number. Deleted integrations and those of deleted widgets are not listed. An empty list means nothing is connected in that scope; it does not prove that deliveries work. A page holds up to limit items; while next_cursor is set, pass it as cursor for the next page.

FieldDescription
site_id
required
Site Id
integer
FieldDescription
widget_id
Widget Id

Only integrations of this widget, id from list_widgets

integer
> 0

Only integrations of this widget, id from list_widgets

kind

Only integrations of this kind

string
Allowed values: service webhook zapier

Only integrations of this kind

service
Service

Only connected services of this name, as in service, such as mailchimp; the other kinds are left out

string
>= 1 characters <= 50 characters

Only connected services of this name, as in service, such as mailchimp; the other kinds are left out

is_active
Is Active

True: only integrations that are on; false: only off

boolean

True: only integrations that are on; false: only off

has_failures
Has Failures

True: only integrations with a delivery created in the last failures_days that is failed now; false: only those without one

boolean

True: only integrations with a delivery created in the last failures_days that is failed now; false: only those without one

failures_days
Failures Days

Window of failures and has_failures: this many 24-hour days back from now

integer
default: 7 >= 1 <= 31

Window of failures and has_failures: this many 24-hour days back from now

cursor
Cursor

next_cursor of the previous page; omit for the first

string

next_cursor of the previous page; omit for the first

limit
Limit

Items per page

integer
default: 50 >= 1 <= 100

Items per page

Successful Response

Media typeapplication/json
IntegrationPage
object
FieldDescription
items
required
Items
Array<object>
Integration
object
FieldDescription
id
required
Id

Integration id, the kind and a number, such as webhook:12

string
kind
required
IntegrationKind

Service: a connected service such as Mailchimp or HubSpot; webhook: a request to a URL the site set up; zapier: a URL that Zapier or a similar automation platform subscribed.

string
Allowed values: service webhook zapier
service
Service

Connected service, such as mailchimp; null for the other kinds

string
nullable
name
Name

Name of the integration; null for webhook and zapier

string
nullable
target_name
Target Name

List, audience or other place in the service the data goes to; null for webhook and zapier

string
nullable
url
Url

Saved destination URL of a webhook or zapier; null for a service

string
nullable
format
Format

Body format of a webhook: JSON or form-encoded; null otherwise

string
nullable
Allowed values: json form
widget
required
Widget

Widget whose responses it sends

object
FieldDescription
id
required
Id

Widget id, as in list_widgets

integer
name
Name
string
nullable
is_active
required
Is Active

True: switched on now; false: switched off now. Says nothing about when it was switched

boolean
created_at
Created At
string format: date-time
nullable
updated_at
Updated At
string format: date-time
nullable
failures
required
Failures

Recent deliveries, over the failures_days of the request

object
FieldDescription
window_days
required
Window Days

The counts cover deliveries created in this many last 24-hour days

integer
deliveries
required
Deliveries

Deliveries created in the window

integer
failed
required
Failed

Of them, the ones whose current status is failed

integer
last_failed_at
Last Failed At

Last time one of the failed deliveries was updated; null when none failed

string format: date-time
nullable
last_succeeded_at
Last Succeeded At

Last time any delivery of it was updated as succeeded, whenever it was created; null when none ever did. Succeeded alone does not prove the destination got the data, see a delivery’s outcome

string format: date-time
nullable
next_cursor
Next Cursor
string
nullable

Example

{
"items": [
{
"kind": "service",
"format": "json"
}
]
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

Unsupported GSC-Version

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"reason": "example",
"next": "example",
"request_id": "example",
"errors": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
],
"metadata": {}
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

Missing or invalid API key or access token

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"reason": "example",
"next": "example",
"request_id": "example",
"errors": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
],
"metadata": {}
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

WWW-Authenticate
string

Authentication scheme: Bearer

Access denied

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"reason": "example",
"next": "example",
"request_id": "example",
"errors": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
],
"metadata": {}
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

widget_not_found: no such widget on the site

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"reason": "example",
"next": "example",
"request_id": "example",
"errors": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
],
"metadata": {}
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

Validation failed

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"reason": "example",
"next": "example",
"request_id": "example",
"errors": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
],
"metadata": {}
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

Rate limited

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"reason": "example",
"next": "example",
"request_id": "example",
"errors": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
],
"metadata": {}
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

Retry-After
integer

Seconds until the bucket refills

Media typeapplication/problem+json

temporarily_unavailable: the delivery records could not be read in time, or limits cannot be enforced; retry later. The heavy request is spent all the same

Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"reason": "example",
"next": "example",
"request_id": "example",
"errors": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
],
"metadata": {}
}
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds