Skip to content
Documentation

List connectors

GET
/api/v1/workspaces/{workspace_id}/connectors
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/connectors?per=10&page=1&integration_type=export' \
  --header 'Authorization: Bearer <token>'

Retrieves connectors.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

integration_type
string
Allowed values: export cdn

Integration type

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
results
required
Array<object>
object
id
required
integer
name
required
string
integration_name
required
string
settings
required
object
setup_fields
object
key
additional properties
string
nullable
export_images

Whether image-library images should be uploaded to this connector during connector exports.

boolean
key
additional properties
any
created_at
required
string format: date-time
updated_at
required
string format: date-time
oauth_authorization_url
required
string
nullable
dynamic_content_profile_id
required

When set, exports created with this connector will always use this dynamic content profile.

string format: uuid
nullable
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": 12345,
      "name": "Mailchimp",
      "integration_name": "mailchimp",
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z",
      "oauth_authorization_url": "https://app.constantcontact.com/oauth2/v1/authorize?client_id=12345&redirect_uri=https://app.constantcontact.com/oauth2/v1/callback&response_type=code&scope=email_profile_read"
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}