Collection

List collection listings

List collection listings

get/ecosystems/{ecosystem_id}/collections/{id}/listings

Path parameters

ecosystem_idstring required
idstring required

ID of the record you are acting upon.

Query parameters

cursorstring nullable

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

limitinteger

Number of records to return

Response

Listings

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "id": "12345",
      "external_id": "12345",
      "card_background_image": {
        "id": "12345",
        "content_type": "application/jpeg"
      },
      "categories": [
        {
          "count": 1
        }
      ],
      "collections": [
        {
          "card_background_image": {
            "id": "12345",
            "content_type": "application/jpeg"
          },
          "count": 1,
          "logo": {
            "id": "12345",
            "content_type": "application/jpeg"
          }
        }
      ],
      "media": [
        {
          "id": "12345",
          "caption": "Media",
          "sequence": 1
        }
      ],
      "partner": {
        "id": "12345",
        "contacts": [
          {
            "id": "12345"
          }
        ],
        "icon": {
          "id": "12345",
          "content_type": "application/jpeg"
        }
      },
      "products": [
        {
          "id": "12345",
          "sequence": 1,
          "count": 1,
          "logo": {
            "id": "12345",
            "content_type": "application/jpeg"
          }
        }
      ],
      "screenshots": [
        {
          "id": "12345",
          "caption": "Screenshot",
          "file": {
            "id": "12345",
            "content_type": "application/jpeg"
          }
        }
      ]
    }
  ],
  "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"
  }
}

Changes

Changed in 5 of the 6 revisions of this API.591439

    • added the optional property data/items/card_background_image to the response with the 200 status

      response-optional-property-added

    • the response property data/items/categories/items/translations/items/key became required for the status 200

      response-property-became-required

    • the response property data/items/categories/items/translations/items/locale became required for the status 200

      response-property-became-required

    • the response property data/items/collections/items/translations/items/key became required for the status 200

      response-property-became-required

    • the response property data/items/collections/items/translations/items/locale became required for the status 200

      response-property-became-required

    • the response property data/items/media/items/translations/items/key became required for the status 200

      response-property-became-required

    • the response property data/items/media/items/translations/items/locale became required for the status 200

      response-property-became-required

    • the response property data/items/products/items/translations/items/key became required for the status 200

      response-property-became-required

    • the response property data/items/products/items/translations/items/locale became required for the status 200

      response-property-became-required

    • the response property data/items/screenshots/items/translations/items/key became required for the status 200

      response-property-became-required

    • the response property data/items/screenshots/items/translations/items/locale became required for the status 200

      response-property-became-required

    • the response property data/items/translations/items/key became required for the status 200

      response-property-became-required

    • the response property data/items/translations/items/locale became required for the status 200

      response-property-became-required

    • added the optional property data/items/categories/items/count to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/collections/items/count to the response with the 200 status

      response-optional-property-added

  • 4e8721dca810315See the full diff
    • removed the optional property data/items/category from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/partner/icon/contentType from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/screenshots/items/file/contentType from the response with the 200 status

      response-optional-property-removed

    • added the optional property data/items/categories to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/collections to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/microsoft_flow_id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/partner/icon/content_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/products to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/screenshots/items/file/content_type to the response with the 200 status

      response-optional-property-added

    • the response property data/items/logo/url became required for the status 200

      response-property-became-required

    • the response property data/items/media/items/url became required for the status 200

      response-property-became-required

    • the response property data/items/name became required for the status 200

      response-property-became-required

    • the response property data/items/partner/company became required for the status 200

      response-property-became-required

    • the response property data/items/partner/contacts/items/name became required for the status 200

      response-property-became-required

    • the response property data/items/partner/icon/url became required for the status 200

      response-property-became-required

    • the response property data/items/screenshots/items/file/url became required for the status 200

      response-property-became-required

    • the response property data/items/slug became required for the status 200

      response-property-became-required

    • the response property links/current became required for the status 200

      response-property-became-required

    • api tag Listing removed

      api-tag-removed

    • added the new optional query request parameter cursor

      new-optional-request-parameter

    • added the new optional query request parameter limit

      new-optional-request-parameter

    • added the optional property links to the response with the 200 status

      response-optional-property-added

    • added the optional property meta to the response with the 200 status

      response-optional-property-added

  • fe50a122114059114See the full diff
    • the response property data/items/automate_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/blendr_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/card_background_color became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/cloud_service_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/combidesk_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/description became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/detail_page_disabled became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/features became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/integromat_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/logo/content_type became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/logo/type became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/media/items/translations/items/value became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/media/items/type became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/meta_tag_description became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/meta_tag_keywords became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/meta_tag_title became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/native_integration became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/native_integration_link became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/contacts/items/email became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/contacts/items/first_name became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/contacts/items/last_name became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/contacts/items/linked_in became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/contacts/items/role became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/contacts/items/twitter became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/icon became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/icon/type became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/listed became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/twitter became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/partner/website became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/piesync_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/pricing became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/published became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/screenshots/items/file became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/screenshots/items/file/type became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/screenshots/items/translations/items/value became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/segment_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/sticky became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/tag_line became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/third_party_integration became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/third_party_integration_link became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/translations/items/value became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/tray_io_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/unify_connector_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/upcoming became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/zapier_id became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/logo/url became optional for the status 200

      response-property-became-optional

    • the response property data/items/media/items/translations/items/key became optional for the status 200

      response-property-became-optional

    • the response property data/items/media/items/translations/items/locale became optional for the status 200

      response-property-became-optional

    • the response property data/items/media/items/url became optional for the status 200

      response-property-became-optional

    • the response property data/items/name became optional for the status 200

      response-property-became-optional

    • the response property data/items/partner/company became optional for the status 200

      response-property-became-optional

    • the response property data/items/partner/contacts/items/name became optional for the status 200

      response-property-became-optional

    • the response property data/items/partner/icon/url became optional for the status 200

      response-property-became-optional

    • the response property data/items/screenshots/items/file/url became optional for the status 200

      response-property-became-optional

    • the response property data/items/screenshots/items/translations/items/key became optional for the status 200

      response-property-became-optional

    • the response property data/items/screenshots/items/translations/items/locale became optional for the status 200

      response-property-became-optional

    • the response property data/items/slug became optional for the status 200

      response-property-became-optional

    • the response property data/items/translations/items/key became optional for the status 200

      response-property-became-optional

    • the response property data/items/translations/items/locale became optional for the status 200

      response-property-became-optional

    • deleted the query request parameter cursor

      request-parameter-removed

    • deleted the query request parameter limit

      request-parameter-removed

    • removed the optional property data/items/card_background_image from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/categories from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/collections from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/microsoft_flow_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/partner/icon/content_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/products from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/items/screenshots/items/file/content_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property links from the response with the 200 status

      response-optional-property-removed

    • removed the optional property meta from the response with the 200 status

      response-optional-property-removed

    • api tag Listing added

      api-tag-added

    • added the optional property data/items/category to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/partner/icon/contentType to the response with the 200 status

      response-optional-property-added

    • added the optional property data/items/screenshots/items/file/contentType to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog