We launched the Accounting Sample!Manage invoices, payments, expenses, and more across multiple connectors.

Search docs

Ecosystem API Reference

Create your own ecosystem with the Ecosystem API.

0.0.6

Introduction

Ecosystem API

Ecosystem

Get ecosystem

get/ecosystems/{ecosystem_id}

Get ecosystem

Path parameters

ecosystem_idstring
required

Responses

200Ecosystems

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "id": "12345",
    "about": "string",
    "alternatives_background_color": "string",
    "alternatives_color": "string",
    "attribution": true,
    "body_background_color": "string",
    "body_button_background_color": "string",
    "body_button_color": "string",
    "body_color": "string",
    "body_link_color": "string",
    "card_settings": {
      "background_color": "string",
      "border_color": "string",
      "border_radius": "string",
      "border_size": "string",
      "color": "string",
      "columns": 0,
      "description_lines": 0,
      "icon_border_radius": "string",
      "icon_shadow_enabled": true,
      "icon_size": 0,
      "shadow_enabled": true,
      "show_action": true,
      "show_badges": true,
      "show_category": true,
      "show_description": true,
      "style": "string"
    },
    "categories_count_badge": true,
    "categories_show_max_items": 0,
    "collections_count_badge": true,
    "collections_title": "string",
    "create_link": "string",
    "cta_settings": {
      "background_color": "string",
      "button_background_color": "string",
      "button_color": "string",
      "button_label": "string",
      "button_link": "string",
      "color": "string",
      "description": "string",
      "enabled": true,
      "title": "string"
    },
    "custom_domain": "string",
    "custom_settings": {
      "css": "string",
      "css_link": "string",
      "domain": "string",
      "html_footer": "string",
      "html_nav": "string",
      "java_script_link": "string"
    },
    "detail_pages_enabled": true,
    "footer_background_color": "string",
    "footer_color": "string",
    "google_site_verification_id": "string",
    "hide_install_buttons": true,
    "home_page_collection_category_cards": true,
    "home_page_show_all_listings": true,
    "installation_request_flow_enabled": true,
    "integration_settings": {
      "albacross_id": "string",
      "automate_enabled": true,
      "blendr_enabled": true,
      "combidesk_enabled": true,
      "crisp_id": "string",
      "drift_id": "string",
      "google_analytics_id": "string",
      "google_tag_manager_id": "string",
      "heap_id": "string",
      "hubspot_portal_id": "string",
      "integromat_enabled": true,
      "intercom_app_id": "string",
      "iubenda_cookie_policy_id": "string",
      "iubenda_site_id": "string",
      "journy_io_domain": "string",
      "journy_io_id": "string",
      "livechat_id": "string",
      "metomic_id": "string",
      "microsoft_flow_id": "string",
      "microsoft_flow_enabled": true,
      "onetrust_id": "string",
      "piesync_enabled": true,
      "segment_id": "string",
      "segment_enabled": true,
      "tray_io_enabled": true,
      "zapier_beta_link": "string",
      "zapier_enabled": true,
      "zapier_id": "string"
    },
    "is_published": true,
    "lead_form_settings": {
      "capture_form_enabled": true,
      "first_name_field_enabled": true,
      "first_name_field_required": true,
      "integration_enabled": true,
      "last_name_field_enabled": true,
      "last_name_field_required": true,
      "telephone_field_enabled": true,
      "telephone_field_required": true,
      "work_email_validation": true
    },
    "listing_settings": {
      "description_text_template": "string",
      "description_title": "string",
      "features_text_template": "string",
      "features_title": "string",
      "install_button_label": "string",
      "name_postfix": "string",
      "naming": "LISTING",
      "native_integration_link": "string",
      "pricing_disabled": true,
      "pricing_text_template": "string",
      "pricing_title": "string",
      "sidebar_position": "TOP"
    },
    "masthead_settings": {
      "background": "string",
      "background_color": "string",
      "color": "string",
      "columns": 0,
      "description": "string",
      "title": "string"
    },
    "menu_position": "TOP",
    "menu_style": "LIST",
    "meta_tag_settings": {
      "description": "string",
      "description_category_page": "string",
      "description_collection_page": "string",
      "description_listing_page": "string",
      "keywords": "string",
      "title": "string",
      "title_postfix": "string"
    },
    "name": "string",
    "navigation_background_color": "string",
    "navigation_color": "string",
    "navigation_logo_post_fix": "string",
    "navigation_mobile_menu_type": "ICON",
    "navigation_sticky": true,
    "primary_color": "string",
    "privacy_link": "string",
    "request_link": "string",
    "shadow_page_description": "string",
    "shadow_pages_enabled": true,
    "show_attribution_badge": true,
    "show_requested_listings": true,
    "slug": "string",
    "terms_link": "string",
    "total_published_listings": 0,
    "unify_application_id": "string",
    "utm_campaign": "string",
    "website": "string",
    "zaps_menu_title": "string",
    "zaps_page_enabled": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Listing

List listings

get/ecosystems/{ecosystem_id}/listings

List listings

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

external_idstring

Filter on external_id

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"
  }
}

Get listing

get/ecosystems/{ecosystem_id}/listings/...

Get listing

Path parameters

ecosystem_idstring
required
idstring
required

ID of the record you are acting upon.

Responses

200Listing

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"
  }
}

Collection

List collections

get/ecosystems/{ecosystem_id}/collectio...

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/ecosystems/{ecosystem_id}/collectio...

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/ecosystems/{ecosystem_id}/collectio...

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"
  }
}

Category

List categories

get/ecosystems/{ecosystem_id}/categorie...

List categories

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

200Categories

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "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"
    }
  ],
  "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"
  }
}

Get category

get/ecosystems/{ecosystem_id}/categorie...

Get category

Path parameters

ecosystem_idstring
required
idstring
required

ID of the record you are acting upon.

Responses

200Category

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "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"
  }
}

List category listings

get/ecosystems/{ecosystem_id}/categorie...

List category 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"
  }
}

Product

List products

get/ecosystems/{ecosystem_id}/products

List products

Path parameters

ecosystem_idstring
required

Responses

200Products

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "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"
  }
}

Get product

get/ecosystems/{ecosystem_id}/products/...

Get product

Path parameters

ecosystem_idstring
required
idstring
required

ID of the record you are acting upon.

Responses

200Product

Response example

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "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"
      }
    ]
  }
}

List product listings

get/ecosystems/{ecosystem_id}/products/...

List product 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"
  }
}