GET
/
v2
/
connections
curl --request GET \
  --url https://api.usecloudpress.com/v2/connections \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 123,
      "kind": "source",
      "lastExport": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "serviceLogoUrl": "<string>",
      "type": "<string>"
    }
  ],
  "pagination": {
    "pageCount": 123,
    "pageNo": 123,
    "pageSize": 123,
    "totalRecordCount": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

kind
enum<string>

The kind of connection to filter by. Cannot be used in conjunction with Type.

Available options:
source,
destination
pageNo
integer | null

The page of results you would like to return.

pageSize
integer | null

The number of items to return per page. By default, 50 items will be returned.

properties
object | null

The connection properties to filter by. Can only be used in conjunction with Type.

sourceReference
string | null

An optional source document reference. If passed, the lastExport field will indicate when this particular document was last exported to each of the listed connections.

type
string | null

The type of connection to filter by. One of:

  • CONTENTFUL
  • KENTICO
  • NOTION
  • SANITY
  • WEBFLOW
  • WORDPRESS Cannot be used in conjunction with Kind.

Response

200
application/json
Success
items
object[]

This object represents a connected account in Cloudpress. These are accounts to which you can export content.

pagination
object