Apideck

Customer Support

Welcome to the Customer Support API. You can use this API to access all Customer Support API endpoints. Base URL The base URL for all API requests is…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the Customer Support API.

You can use this API to access all Customer Support API endpoints.

Base URL

The base URL for all API requests is https://unify.apideck.com

We also provide a Mock API that can be used for testing purposes: https://mock-api.apideck.com

Headers

Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

NameTypeRequiredDescription
x-apideck-consumer-idStringYesThe id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.
x-apideck-service-idStringNoDescribe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.
x-apideck-rawBooleanNoInclude raw response. Mostly used for debugging purposes.
x-apideck-app-idStringYesThe application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
AuthorizationStringYesBearer API KEY

Authorization

You can interact with the API through the authorization methods below.

-->

Pagination

All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.

To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.

In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.

Query Parameters

NameTypeRequiredDescription
cursorStringNoCursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.
limitNumberNoNumber of results to return. Minimum 1, Maximum 200, Default 20

Response Body

NameTypeDescription
meta.cursors.previousStringCursor to navigate to the previous page of results through the API
meta.cursors.currentStringCursor to navigate to the current page of results through the API
meta.cursors.nextStringCursor to navigate to the next page of results through the API
meta.items_on_pageNumberNumber of items returned in the data property of the response
links.previousStringLink to navigate to the previous page of results through the API
links.currentStringLink to navigate to the current page of results through the API
links.nextStringLink to navigate to the next page of results through the API

⚠️ meta.cursors.previous/links.previous is not available for all connectors.

SDKs and API Clients

We currently offer a Node.js, PHP and .NET SDK.
Need another SDK? Request the SDK of your choice.

Debugging

Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.

Errors

The…

Endpoints 5

Customers

  • GETList Customer Support Customers/customer-support/customers?raw=false&cursor=string&limit=20&fields=id,updated_atList Customer Support Customers
  • POSTCreate Customer Support Customer/customer-support/customers?raw=falseCreate Customer Support Customer
  • GETGet Customer Support Customer/customer-support/customers/:id?raw=false&fields=id,updated_atGet Customer Support Customer
  • DELETEDelete Customer Support Customer/customer-support/customers/:id?raw=falseDelete Customer Support Customer
  • PATCHUpdate Customer Support Customer/customer-support/customers/:id?raw=falseUpdate Customer Support Customer

API details

Base URL
https://unify.apideck.com
Authentication
An API key in the Authorization header
Operations
5 operations on 2 pathsGET 2POST 1PATCH 1DELETE 1
Main resources
Customers 5
Description format
OpenAPI 3.0.0, API version 9.5.0

How to test the Customer Support in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Customer Support collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List Customer Support Customers” (GET /customer-support/customers?raw=false&cursor=string&limit=20&fields=id,updated_at), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Customer Support?

Welcome to the Customer Support API. You can use this API to access all Customer Support API endpoints. Base URL The base URL for all API requests is… It is listed under Developer tools and has 5 endpoints.

Who publishes the Customer Support?

It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Customer Support?

Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.

How do I authenticate with the Customer Support?

With an API key in the Authorization header.

How many endpoints does the Customer Support have?

5 operations on 2 paths (2 GET, 1 POST, 1 PATCH, 1 DELETE). The largest groups are Customers.

Is forking the Customer Support free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.