Collection

Collection endpoints for the Ecosystem API Unified API

0.0.6
|Full reference

List collections

get
https://api.apideck.com/ecosystems/{ecosystem_id}/collections

List collections

Path parameters

ecosystem_idstring
required

Query parameters

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:50

Number of records to return

Responses

200Collections

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "id": "string",
      "card_background_color": "string",
      "card_background_image": {
        "id": "12345",
        "content_type": "application/jpeg",
        "type": "LOGO",
        "url": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "card_columns": 0,
      "card_style": "string",
      "count": 1,
      "description": "string",
      "logo": {
        "id": "12345",
        "content_type": "application/jpeg",
        "type": "LOGO",
        "url": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "name": "string",
      "hidden_from_homepage": true,
      "show_max_items_homepage": 0,
      "sequence": 0,
      "slug": "string",
      "translations": [
        {
          "key": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "visible": true
    }
  ]
}

Get collection

get
https://api.apideck.com/ecosystems/{ecosystem_id}/collections/{id}

Get collection

Path parameters

ecosystem_idstring
required
idstring
required

ID of the record you are acting upon.

Responses

200Collection

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "id": "string",
    "card_background_color": "string",
    "card_background_image": {
      "id": "12345",
      "content_type": "application/jpeg",
      "type": "LOGO",
      "url": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "card_columns": 0,
    "card_style": "string",
    "count": 1,
    "description": "string",
    "logo": {
      "id": "12345",
      "content_type": "application/jpeg",
      "type": "LOGO",
      "url": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "name": "string",
    "hidden_from_homepage": true,
    "show_max_items_homepage": 0,
    "sequence": 0,
    "slug": "string",
    "translations": [
      {
        "key": "string",
        "locale": "string",
        "value": "string"
      }
    ],
    "visible": true
  }
}

List collection listings

get
https://api.apideck.com/ecosystems/{ecosystem_id}/collections/{id}/listings

List collection listings

Path parameters

ecosystem_idstring
required
idstring
required

ID of the record you are acting upon.

Query parameters

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:50

Number of records to return

Responses

200Listings

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "id": "12345",
      "external_id": "12345",
      "automate_id": "string",
      "blendr_id": "string",
      "card_background_color": "string",
      "card_background_image": {
        "id": "12345",
        "content_type": "application/jpeg",
        "type": "LOGO",
        "url": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "categories": [
        {
          "id": "string",
          "description": "string",
          "name": "string",
          "slug": "string",
          "count": 1,
          "translations": [
            {
              "key": "string",
              "locale": "string",
              "value": "string"
            }
          ],
          "listing_description_text_template": "string",
          "listing_pricing_text_template": "string",
          "listing_features_text_template": "string",
          "logo": {
            "content_type": "string",
            "id": "string",
            "type": "LOGO",
            "url": "string"
          },
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "cloud_service_id": "string",
      "combidesk_id": "string",
      "collections": [
        {
          "id": "string",
          "card_background_color": "string",
          "card_background_image": {
            "id": "12345",
            "content_type": "application/jpeg",
            "type": "LOGO",
            "url": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          },
          "card_columns": 0,
          "card_style": "string",
          "count": 1,
          "description": "string",
          "logo": {
            "id": "12345",
            "content_type": "application/jpeg",
            "type": "LOGO",
            "url": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          },
          "name": "string",
          "hidden_from_homepage": true,
          "show_max_items_homepage": 0,
          "sequence": 0,
          "slug": "string",
          "translations": [
            {
              "key": "string",
              "locale": "string",
              "value": "string"
            }
          ],
          "visible": true
        }
      ],
      "description": "string",
      "detail_page_disabled": true,
      "features": "string",
      "integromat_id": "string",
      "logo": {
        "content_type": "string",
        "id": "string",
        "type": "LOGO",
        "url": "string"
      },
      "meta_tag_description": "string",
      "meta_tag_keywords": "string",
      "meta_tag_title": "string",
      "microsoft_flow_id": "string",
      "name": "string",
      "native_integration": true,
      "native_integration_link": "string",
      "media": [
        {
          "id": "12345",
          "caption": "Media",
          "type": "SCREENSHOT",
          "url": "string",
          "sequence": 1,
          "translations": [
            {
              "key": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        }
      ],
      "partner": {
        "id": "12345",
        "company": "string",
        "contacts": [
          {
            "id": "12345",
            "first_name": "string",
            "last_name": "string",
            "name": "string",
            "email": "string",
            "role": "string",
            "linked_in": "string",
            "twitter": "string"
          }
        ],
        "icon": {
          "id": "12345",
          "content_type": "application/jpeg",
          "type": "LOGO",
          "url": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        },
        "listed": "string",
        "twitter": "string",
        "website": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      },
      "piesync_id": "string",
      "pricing": "string",
      "products": [
        {
          "id": "12345",
          "name": "string",
          "slug": "string",
          "description": "string",
          "visible": true,
          "sequence": 1,
          "count": 1,
          "logo": {
            "id": "12345",
            "content_type": "application/jpeg",
            "type": "LOGO",
            "url": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          },
          "translations": [
            {
              "key": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        }
      ],
      "published": true,
      "published_at": "2019-08-24T14:15:22Z",
      "screenshots": [
        {
          "id": "12345",
          "caption": "Screenshot",
          "file": {
            "id": "12345",
            "content_type": "application/jpeg",
            "type": "LOGO",
            "url": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          },
          "translations": [
            {
              "key": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        }
      ],
      "segment_id": "string",
      "slug": "string",
      "sticky": true,
      "tag_line": "string",
      "third_party_integration": true,
      "third_party_integration_link": "string",
      "translations": [
        {
          "key": "string",
          "locale": "string",
          "value": "string"
        }
      ],
      "tray_io_id": "string",
      "unify_connector_id": "string",
      "upcoming": true,
      "zapier_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://api.apideck.com/ecosystem/123abc/listings?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://api.apideck.com/ecosystem/123abc/listings",
    "next": "https://api.apideck.com/ecosystem/123abc/listings?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}