Airbyte Configuration API https://airbyte.io. This API is a collection of HTTP RPC-style methods. While it is not a REST API, those familiar with REST should find the conventions of this API recognizable. Here are some conventions that this API follows: All endpoints are http POST methods. All endpoints accept data via application/json request bodies. The API does not accept any data via query params. The naming convention for endpoints is: localhost:8000/{VERSION}/{METHODFAMILY}/{METHODNAME} e.g. localhost:8000/v1/connections/create. For all update methods, the whole object must be passed in, even the fields that did not change. Change Management: The major version of the API endpoint can be determined / specified in the URL localhost:8080/v1/connections/create Minor version bumps will be invisible to the end user. The user cannot specify minor versions in requests. All backwards incompatible changes will happen in major version bumps. We will not make backwards incompatible changes in minor version bumps. Examples of non-breaking changes (includes but not limited to...): Adding fields to request or response bodies. Adding new HTTP endpoints.

Airbyte Configuration API

Introduction Api2Pdf is a powerful PDF generation API with no rate limits or file size constraints. Api2Pdf runs on AWS Lambda, a serverless architecture powered by Amazon to scale to millions of requests while being up to 90% cheaper than alternatives. Supports wkhtmltopdf, Headless Chrome, LibreOffice, and PDF Merge. You can also generate barcodes with ZXING (Zebra Crossing). SDKs & Client Libraries We've made a number of open source libraries available for the API Python: https://github.com/api2pdf/api2pdf.python .NET: https://github.com/api2pdf/api2pdf.dotnet Nodejs: https://github.com/api2pdf/api2pdf.node PHP: https://github.com/Api2Pdf/api2pdf.php Ruby: (Coming soon) Authorization Create an account at portal.api2pdf.com to get an API key. Authorize your API calls GET requests, include apikey=YOUR-API-KEY as a query string parameter POST requests, add Authorization to your header. For more advanced usage and settings, see the API specification below.

Api2Pdf - PDF Generation, Powered by AWS Lambda

Apicurio Registry is a datastore for standard event schemas and API designs. Apicurio Registry enables developers to manage and share the structure of their data using a REST interface. For example, client applications can dynamically push or pull the latest updates to or from the registry without needing to redeploy. Apicurio Registry also enables developers to create rules that govern how registry content can evolve over time. For example, this includes rules for content validation and version compatibility. The Apicurio Registry REST API enables client applications to manage the artifacts in the registry. This API provides create, read, update, and delete operations for schema and API artifacts, rules, versions, and metadata. The supported artifact types include: Apache Avro schema AsyncAPI specification Google protocol buffers GraphQL schema JSON Schema Kafka Connect schema OpenAPI specification Web Services Description Language XML Schema Definition Important: The Apicurio Registry REST API is available from https://MY-REGISTRY-URL/apis/registry/v2 by default. Therefore you must prefix all API operation paths with ../apis/registry/v2 in this case. For example: ../apis/registry/v2/ids/globalIds/{globalId}.

Apicurio Registry API [v2]

Welcome to the Accounting API. You can use this API to access all Accounting 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

Accounting API

Welcome to the CRM API. You can use this API to access all CRM 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

CRM API

Welcome to the Lead API. You can use this API to access all Lead 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

Lead API

Welcome to the Proxy API. You can use this API to access all Proxy API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | ---------------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Authorization | String | Yes | Bearer API KEY | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | x-apideck-consumer-id | String | Yes | The 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-downstream-url | String | Yes | Downstream URL to forward the request too | | x-apideck-downstream-authorization | String | No | Downstream authorization header. This will skip the Vault token injection. | | x-apideck-downstream-method | String | No | Downstream method. If not provided the upstream method will be inherited, depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT. | | x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. | Authorization You can interact with the API through the authorization methods below. apiKey To use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app. Your Apideck application_id can also be found on the same page. Authenticate your API requests by including your test or live secret API key in the request header. Bearer authorization header: Authorization: Bearer Application id header: x-apideck-app-id: You should use the public keys on the SDKs and the secret keys to authenticate API requests. Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub. Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys | Security Scheme Type | HTTP | | ------------------------- | ------ | | HTTP Authorization Scheme | bearer | applicationId The ID of your Unify application | Security Scheme Type | API Key | | --------------------- | ---------------- | | Header parameter name | x-apideck-app-id | Static IP Some of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to the Proxy API with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers. To use this feature, the API Vendor will need to whitelist the associated static IP addresses. The provided static IP addresses are fixed to their specified region and shared by all customers who use this feature. EU Central 1: 18.197.244.247 Other: upcoming More info about our data security can be found at https://compliance.apideck.com/ Limitations Timeout The request timeout is set at 30 seconds. Response Size The Proxy API has no response size limit. For responses larger than 2MB, the Proxy API will redirect to a temporary URL. In this case the usual Apideck response headers will be returned in the redirect response. Most HTTP clients will handle this redirect automatically. GET /proxy < 301 Moved Permanently < x-apideck-request-id: {{requestId}} < Location: {{temporaryUrl}} GET {{temporaryUrl}}

Proxy API

Welcome to the Vault API 👋 When you're looking to connect to an API, the first step is authentication. Vault helps you handle OAuth flows, store API keys, and refresh access tokens from users (called consumers in Apideck). Base URL The base URL for all API requests is https://unify.apideck.com Get Started To use the Apideck APIs, you need to sign up for free at https://app.apideck.com/signup. Follow the steps below to get started. Create a free account. Go to the Dashboard. Get your API key and the application ID. Select and configure the integrations you want to make available to your users. Through the Unify dashboard, you can configure which connectors you want to support as integrations. Retrieve the clientid and clientsecret for the integration you want to activate (Only needed for OAuth integrations). Soon, you can skip the previous step and use the Apideck sandbox credentials to get you started instead (upcoming) Register the redirect URI for the example app (https://unify.apideck.com/vault/callback) in the list of redirect URIs under your app's settings Use the publishing guides to get your integration listed across app marketplaces. Hosted Vault Hosted Vault (vault.apideck.com) is a no-code solution, so you don't need to build your own UI to handle the integration settings and authentication. Hosted Vault - Integrations portal Behind the scenes, Hosted Vault implements the Vault API endpoints and handles the following features for your customers: Add a connection Handle the OAuth flow Configure connection settings per integration Manage connections Discover and propose integration options Search for integrations (upcoming) Give integration suggestions based on provided metadata (email or website) when creating the session (upcoming) To use Hosted Vault, you will need to first create a session. This can be achieved by making a POST request to the Vault API to create a valid session for a user, hereafter referred to as the consumer ID. Example using curl: Vault API Beware, this is strategy takes more time to implement in comparison to Hosted Vault. If you are building your integration settings UI manually, you can call the Vault API directly. The Vault API is for those who want to completely white label the in-app integrations overview and authentication experience. All the available endpoints are listed below. Through the API, your customers authenticate directly in your app, where Vault will still take care of redirecting to the auth provider and back to your app. If you're already storing access tokens, we will help you migrate through our Vault Migration API (upcoming). Domain model At its core, a domain model creates a web of interconnected entities. Our domain model contains five main entity types: Consumer (user, account, team, machine), Application, Connector, Integration, and Connection. Connection state The connection state is computed based on the connection flow below. Unify and Proxy integration The only thing you need to use the Unify APIs and Proxy is the consumer id; thereafter, Vault will do the look-up in the background to handle the token injection before performing the API call(s). Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-app-id | String | Yes | The id of your Unify application. Available at https://app.apideck.com/api-keys. | | x-apideck-consumer-id | String | Yes | The 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | Sandbox (upcoming) The sandbox is pre-loaded with data similar to a real-life integrations setup. You can use the preconfigured OAauth configured connectors for testing purposes and can skip this step by using the Apideck sandbox credentials to get you started. Guides How to build an integrations UI with Vault How to configure the OAuth credentials for integration providers (COMING SOON) FAQ What purpose does Vault serve? Can I just handle the authentication and access token myself? You can store everything yourself, but that defeats the purpose of using Apideck Unify. Handling tokens for multiple providers can quickly become very complex. Is my data secure? Vault employs data minimization, therefore only requesting the minimum amount of scopes needed to perform an API request. How do I migrate existing data? Using our migration API, you can migrate the access tokens and accounts to Apideck Vault. (COMING SOON) Can I use Vault in combination with existing integrations? Yes, you can. The flexibility of Unify allows you to quickly the use cases you need while keeping a gradual migration path based on your timeline and requirements. How does Vault work for Apideck Ecosystem customers? Once logged in, pick your ecosystem; on the left-hand side of the screen, you'll have the option to create an application underneath the Unify section. How to integrate Apideck Vault This section covers everything you need to know to authenticate your customers through Vault. Vault provides three auth strategies to use API tokens from your customers: Vault API Hosted Vault Apideck Ecosystem (COMING SOON) You can also opt to bypass Vault and still take care of authentication flows yourself. Make sure to put the right safeguards in place to protect your customers' tokens and other sensitive data. What auth types does Vault support? What auth strategies does Vault handle? We currently support three flows so your customers can activate an integration. API keys For Services supporting the API key strategy, you can use Hosted Vault will need to provide an in-app form where users can configure their API keys provided by the integration service. OAuth 2.0 Authorization Code Grant Type Flow Vault handles the complete Authorization Code Grant Type Flow for you. This flow only supports browser-based (passive) authentication because most identity providers don't allow entering a username and password to be entered into applications that they don't own. Certain connectors require an OAuth redirect authentication flow, where the end-user is redirected to the provider's website or mobile app to authenticate. This is being handled by the /authorize endpoint. Basic auth Basic authentication is a simple authentication scheme built into the HTTP protocol. The required fields to complete basic auth are handled by Hosted Vault or by updating the connection through the Vault API below.

Vault API

Welcome to the File Storage API. You can use this API to access all File Storage 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

File storage API

Welcome to the Webhook API. You can use this API to access all Webhook 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

Webhook API

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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

Customer Support

Welcome to the SMS API. You can use this API to access all SMS 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

SMS API

Welcome to the ATS API. You can use this API to access all ATS 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

ATS API

Welcome to the HRIS API. You can use this API to access all HRIS 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

HRIS API

Welcome to the Connector API. You can use this API to access all Connector 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

Connector API

Welcome to the POS API. You can use this API to access all POS 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 GraphQL Use the GraphQL playground to test out the GraphQL API. Headers Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. | Name | Type | Required | Description | | --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | x-apideck-consumer-id | String | Yes | The 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-id | String | No | Describe 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-raw | Boolean | No | Include raw response. Mostly used for debugging purposes. | | x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. | | Authorization | String | Yes | Bearer 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 | Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. | | limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 | Response Body | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------ | | meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API | | meta.cursors.current | String | Cursor to navigate to the current page of results through the API | | meta.cursors.next | String | Cursor to navigate to the next page of results through the API | | meta.itemsonpage | Number | Number of items returned in the data property of the response | | links.previous | String | Link to navigate to the previous page of results through the API | | links.current | String | Link to navigate to the current page of results through the API | | links.next | String | Link 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 API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below. | Code | Title | Description | | ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 200 | OK | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data. | | 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. | | 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. | | 400 | Bad Request | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. | | 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. | | 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. | | 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. | | 404 | Not Found | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. | | 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. | | 422 | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions. | | 429 | Too Many Requests | You sent too many requests in a given amount of time ("rate limit"). Try again later | | 5xx | Server Errors | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue. | Handling errors The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability. Error Types RequestValidationError Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification. UnsupportedFiltersError Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response. UnsupportedSortFieldError Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response. InvalidCursorError Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector. ConnectorExecutionError A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail. UnauthorizedError We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sklive*' ConnectorCredentialsError A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use. ConnectorDisabledError A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue. ConnectorRateLimitError You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later. RequestLimitError You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately. EntityNotFoundError You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource. OAuthCredentialsNotFoundError When adding a connector integration that implements OAuth, both a clientid and clientsecret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing. IntegrationNotFoundError The requested connector integration could not be found associated to your applicationid. Verify your applicationid is correct, and that this connector has been added and configured for your application. ConnectionNotFoundError A valid connection could not be found associated to your applicationid. Something may_ have interrupted the authorization flow. You may need to start the connector authorization process again. ConnectionSettingsError The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable. ConnectorNotFoundError A request was made for an unknown connector. Verify your serviceid is spelled correctly, and that this connector is enabled for your provided unifiedapi. OAuthRedirectUriError A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process. OAuthInvalidStateError The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed. OAuthCodeExchangeError When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue. OAuthConnectorError It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. MappingError There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue. ConnectorMappingNotFoundError It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorResponseMappingNotFoundError We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationMappingNotFoundError Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorWorkflowMappingError The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. ConnectorOperationUnsupportedError You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one. PaginationNotSupportedError Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue. API Design API Styles and data formats REST API The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail. Available HTTP methods The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \_method. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience. Schema All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data. Meta Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources. Idempotence (upcoming) To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once. Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.) Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution. Fixed field types Dates The dates returned by the API are all represented in UTC (ISO8601 format). This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition. The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures. Prices and Currencies All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents). For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5. All currency codes conform to ISO 4217. Support If you have problems or need help with your case, you can always reach out to our Support.

POS API

Ecosystem API

The Registry service allows teams to manage descriptions of APIs.

Registry

Transform API Descriptions from/to various formats

APIMATIC API Transformer

Wikipedia for Web APIs. Repository of API specs in OpenAPI 3.0 format. Warning: If you want to be notified about changes in advance please join our Slack channel. Client sample: [Demo] [Repo]

APIs.guru

Bulk WHOIS API

App Center Client

App Store Connect API

Apptigent PowerTools Developer Edition is a powerful suite of API endpoints for custom applications running on any stack. Manipulate text, modify collections, format dates and times, convert currency, perform advanced mathematical calculations, shorten URL's, encode strings, convert text to speech, translate content into multiple languages, process images, and more. PowerTools is the ultimate developer toolkit.

PowerTools Developer

AppVeyor is a hosted continuous integration service which runs on Microsoft Windows. The AppVeyor REST API provides a RESTful way to interact with the AppVeyor service. This includes managing projects, builds, deployments, and the teams that build them. Additional help and discussion of the AppVeyor REST API is available at http://help.appveyor.com/discussions This Swagger definition is an unofficial description of the AppVeyor REST API maintained at https://github.com/kevinoid/appveyor-swagger Please report any issues or suggestions for this Swagger definition at https://github.com/kevinoid/appveyor-swagger/issues/new API Conventions Fields which are missing from update operations (PUT requests) are typically reset to their default values. So although most fields are not technically required, they should usually be specified in practice.

AppVeyor REST API

Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to https://appwrite.io/docs

Appwrite

This is the interface for interacting with the Asana Platform. Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/developer-docs/master/defs/asana_oas.yaml).

Asana

Jira Cloud platform REST API documentation

The Jira Cloud platform REST API

Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.

Bitbucket API

Blazemeter API Explorer

Containers are virtual software objects that include all the elements that an app needs to run. A container has the benefits of resource isolation and allocation but is more portable and efficient than, for example, a virtual machine. This documentation describes the IBM Containers API, which is based on the Docker Remote API. The API provides endpoints that you can use to create and manage your single containers and container groups in Bluemix. Endpoints are summarized under the following tags: Authentication: Retrieve and refresh your TLS certificates. Private Docker images registry: Create your own private Docker images registry in Bluemix by setting a namespace for your organization. Images: View, build, and push your images to your private Bluemix registry so you can use them with IBM Containers. You can also scan your container images with the Vulnerability Advisor against standard policies set by the organization manager and a database of known Ubuntu issues. Single Containers: Create and manage single containers in Bluemix. Use a single container to implement short-lived processes or to run simple tests as you develop an app or service. To make your single container available from the internet, review the Public IP addresses endpoints. Container Groups: Create and manage your container groups in Bluemix. A container group consists of multiple single containers that are all created from the same container image and as a consequence are configured in the same way. Container groups offer further options at no cost to make your app highly available. These options include in-built load balancing, auto-recovery of unhealthy container instances, and auto-scaling of container instances based on CPU and memory usage. Map a public route to your container group to make your app accessible from the internet. Public IP addresses: Use these endpoints to request public IP addresses for your space. You can bind this IP address to your container to make your container accessible from the internet. File shares: Create, list and delete file shares in a space. A file share is a NFS storage system that hosts Docker volumes. Volumes: Create and manage container volumes in your space to persist the data of your containers. Each API request requires an HTTP header that includes the 'X-Auth-Token’ and 'X-Auth-Project-Id’ parameter. X-Auth-Token: The JSON web token (JWT) that you receive when logging into the Bluemix platform. It allows you to use the IBM Containers REST API, access services, and resources. Run cf oauth-token to retrieve your access token information. X-Auth-Project-Id: The unique ID of your organization space where you want to create or work with your containers. Run cf space --guid, where is the name of your space, to retrieve your space ID. For further information about how containers work in the IBM Containers service, review the documentation under https://new-console.ng.bluemix.net/docs/containers/container_index.html.

IBM Containers API

The CircleCI API is a RESTful, fully-featured API that allows you to do almost anything in CircleCI. You can access all information and trigger all actions. The only thing we don’t provide access to is billing functions, which must be done from the CircleCI web UI.

CircleCI REST API

CodeScan API

OpenAPI for https://codesearch.debian.net/

Debian Code Search

Base API URL: https://api.configcat.com If you prefer the swagger documentation, you can find it here: Swagger UI. The purpose of this API is to access the ConfigCat platform programmatically. You can Create, Read, Update and Delete any entities like Feature Flags, Configs, Environments or Products within ConfigCat. The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON and JSON+HAL format. Do not use this API for accessing and evaluating feature flag values. Use the SDKs instead. OpenAPI Specification The complete specification is publicly available here: swagger.json. You can use it to generate client libraries in various languages with OpenAPI Generator or Swagger Codegen to interact with this API. Authentication This API uses the Basic HTTP Authentication Scheme. Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time	when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a HTTP 429 - Too many requests status along with a Retry-After HTTP header.

ConfigCat Public Management API

What's in this version: Compare two screenshots for layout differences Compare a full screenshot test of browsers to a single baseline browser for layout differences. Compare a screenshot test version to another test version - good for regression tests. Get links to the Comparison UI for visual representation of layout differences

Crossbrowsertesting.com Screenshot Comparisons API

Crucible

User Recommendation Engine and Chat Network

DaniWeb Connect API

Render Javascript driven pages, while we internally manage Headless Chrome and proxies for you. Build a custom web scraper with our Visual point-and-click toolkit. Scrape the most popular Search engines result pages (SERP). Convert web pages to PDF and capture screenshots. Authentication Dataflow Kit API require you to sign up for an API key in order to use the API. The API key can be found in the DFK Dashboard after free registration. Pass a secret API Key to all API requests to the server as the api_key query parameter.

Dataflow Kit Web Scraper

Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.

Etherpad API

JSON storage

Extpose — in‑store performance analytics and optimization tool for Chrome extensions. https://extpose.com

Extpose

Fisheye Crucible

FishEye

The API to manage the GameSparks game details

GameSparks Game Details API

The Postman API allows you to programmatically access data stored in Postman account with ease. The easiest way to get started with the API is to click the fork button to fork this collection to your own workspace and use Postman to send requests. Overview You need a valid API Key to send requests to the API endpoints. You can get your key from the integrations dashboard. The API has an access rate limit applied to it. The Postman API will only respond to secured communication done over HTTPS. HTTP requests will be sent a 301 redirect to corresponding HTTPS resources. Response to every request is sent in JSON format. In case the API request results in an error, it is represented by an "error": {} key in the JSON response. The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Postman, and POST implies you want to save something new to Postman. The API calls will respond with appropriate HTTP status codes for all requests. Within Postman Client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A 200 OK indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively. Individual resources in your Postman Account is accessible using its unique id (uid). The uid is a simple concatenation of the resource owner's user-id and the resource-id. For example, a collection's uid is {{ownerid}}-{{collectionid}}. Authentication An API Key is required to be sent as part of every request to the Postman API, in the form of an X-Api-Key request header. > If you do not have an API Key, you can easily generate one by heading over to the Postman Integrations Dashboard. An API Key tells our API server that the request it received came from you. Everything that you have access to in Postman is accessible with an API Key that is generated by you. For ease of use inside Postman, you could store your API key in an environment variable called postmanapikey and this Collection will automatically use it to make API calls. API Key related error response If an API Key is missing, malformed, or invalid, you will receive a 401 Unauthorised response code and the following JSON response: Support For help regarding accessing the Postman API, feel free to discuss it in our Discourse Community. You can also drop in a line at help@getpostman.com. In the event you receive a 503 response from our servers, it implies that we have hit an unexpected spike in API access traffic and would usually be operational within the next 5 minutes. If the outage persists, or your receive any other form of 5XX error, kindly let us know. Terms of Use For information on API terms of use and privacy, refer to our terms at http://postman.com/legal/terms/ and our privacy policy at https://www.postman.com/legal/privacy-policy/. API Reference

Postman API

Sandbox API

This documentation describes the Gitea API.

Gitea API.

The platform for modern developers GitLab unifies issues, code review, CI and CD into a single UI

Gitlab

A simple HTTP Request & Response Service. Run locally: $ docker run -p 80:80 kennethreitz/httpbin

httpbin.org

This API enables you to convert an amount of one currency into another currency using current foreign exchange rates.

Interzoid Convert Currency Rate API

This API provides a similarity key used to match with other similar street address data, including for purposes of deduplication, fuzzy matching, or merging of datasets. A much higher match rate will be achieved by matching on the algorithmically generated similarity key rather than the data itself.

Interzoid Get Address Match Similarity Key API

This API provides area code information for a given telephone number.

Interzoid Get Area Code From Number API

This API provides a similarity key used to match with other similar city name data, including for purposes of deduplication, fuzzy matching, or merging of datasets. A much higher match rate will be achieved by matching on the algorithmically generated similarity key rather than the data itself.

Interzoid Get City Match Similarity Key API

This API provides a standard for US and international cities for the purposes of standardizing city name data, improving query results, analytics, and data merging.

Interzoid City Data Standardization API

This API provides a similarity key used to match with other similar company name data, including for purposes of deduplication, fuzzy matching, or merging of datasets. A much higher match rate will be achieved by matching on the algorithmically generated similarity key rather than the data itself.

Interzoid Get Company Name Match Similarity Key API

This API provides a similarity key used to match with other similar country name data, including for purposes of deduplication, fuzzy matching, or merging of datasets. A much higher match rate will be achieved by matching on the algorithmically generated similarity key rather than the data itself.

Interzoid Get Country Match Similarity Key API

This API provides a standard for country name for the purposes of standardizing country name data, improving query results, analytics, and data merging.

Interzoid Country Data Standardization API

This API retrieves the latest currency exchange rate, against the US Dollar, for the given three-letter international currency code. These currency rates are compiled from many global sources and are updated several times per day.

Interzoid Get Currency Rate API

This API provides validation information for email addresses to aid in deliverability. Syntax, existence of mail servers, and other tests are run to ensure delivery. Additional demographics are provided for the email address as well, including identifying generic, vulgar, education, government, or other entity type email addresses.

Interzoid Get Email Information API

This API provides a similarity key used to match with other similar full name data, including for purposes of deduplication, fuzzy matching, or merging of datasets. A much higher match rate will be achieved by matching on the similarity key rather than the data itself. This API is for full name data where first and last name are in the same field. Use the Full Name Parsed Similarity Key API for first and last name data that are in separate fields.

Interzoid Get Full Name Match Similarity Key API

This API provides a similarity key used to match with other similar full name data when data fields are parsed into first name and last name components, including for purposes of deduplication, fuzzy matching, or merging of datasets. A much higher match rate will be achieved by matching on the similarity key rather than the data itself. This API is for full name data where first and last name are in separate fields. Use the Full Name Similarity Key API for first and last name data that are in the same field.

Interzoid Get Full Name Parsed Match Similarity Key API

This API provides geographic information for a global telephone number, including city and country information, primary languages spoken, and mobile device identification.

Interzoid Get Global Phone Number Information API

This API retrieves the current time for a city or geographic location around the globe.

Interzoid Get Global Time API

This API provides the two-letter state abbreviation (or the province abbreviation for Canada) for the purposes of standardizing state name data, improving query results, analytics, and data merging.

Interzoid State Data Standardization API

This API provides current weather information for US Cities, including temperatures, wind speeds, wind direction, relative humidity, and visibility.

Interzoid Get Weather City API

Interzoid Get Weather By Zip Code API

This API provides detailed information for a given zip code, including city, state, latitude, longitude, area size, and various population demographics.

Interzoid Zip Code Detailed Info API

This API provides a timed, browser-simulated page load function (or a measured API call) from the specified geography using a server from that geography.

Interzoid Global Page Load Performance API

This API provides area code information for a given telephone area code.

Interzoid Get Area Code API

IP2WHOIS is a free tool to allow you to check WHOIS information for a particular domain, such as domain assigned owner contact information, registrar information, registrant information, location and much more.

IP2WHOIS Domain Lookup

The reliable, secure, and simple IP geolocation API.

ipTwist

JIRA 7.6.1

This is a REST API reference for the Keycloak Admin

Keycloak Admin REST API

Kubernetes

LambdaTest Screenshots API Documentation

Build custom integrations with the LaunchDarkly REST API

LaunchDarkly REST API

The REST API for LGTM provides data so that you can customize how you integrate LGTM analysis into your workflow. It includes the following resources: / (API root)—get version information or download the specification in OpenAPI format. /projects (Projects)—list projects, get a summary of the current status for a project, or add new projects. /analyses (Analyses)—get a summary of results, download all the alerts, or trigger analysis for a specific commit. /codereviews (Code reviews)—trigger code review for a patch, and view the results. /operations (Operations)—get information about long-running tasks, for example, analyses or code reviews that you've requested. /snapshots (Snapshots)—download and upload databases representing a snapshot of a codebase. /queryjobs (Query jobs)—submit queries to evaluate against existing projects, and download their results. /system (System)—get information on the health or usage of the system. For an overview and getting started topics, see API for LGTM.

LGTM API specification

API to easily extract data from websites. Base URL All URLs referenced in the documentation have the following base: You can check anytime how many credits you did use already by logging into your link.fish account at https://app.link.fish and checking under: "Plugins" -> "API Dashboard" If you have problems, questions or improvement advice please send us an email to api@link.fish

link.fish API

Otoroshi Admin API

The GeoDB API focuses on getting global city and region data. Easily obtain country, region, and city data for use in your apps! Filter cities by name prefix, country, location, time-zone, and even minimum population. Sort cities by name, country code, elevation, and population - or any combination of these. Get all country regions. Get all cities in a given region. Display results in multiple languages. RESTful API adheres to industry best-practices, including HATEOAS-style links to facilitate paging results. Backed by cloud-based load-balanced infrastructure for resiliency and performance! Data is periodically refreshed from GeoNames and WikiData. Notes: Since the database is periodically updated, this may very rarely result in certain cities being marked deleted (e.g., duplicates removed). By default, endpoints returning city data will exclude cities marked deleted. However, in the unlikely event that this occurs while your app is paging through a set of affected results - and you care about the paged results suddenly changing underneath - specify includeDeleted=SINCEYESTERDAY (or SINCELAST_WEEK if you're really paranoid!). Useful Resources SDKs Angular, Sample App Java JavaScript Swagger Docs Usage License

GeoDB Cities API

Converter and validator for Swagger 2.0 to OpenAPI 3.0.x definitions

Swagger2OpenAPI Converter

Autosuggest supplies search terms derived from a root text sent to the service. The terms Autosuggest supplies are related to the root text based on similarity and their frequency or ratings of usefulness in other searches. For examples that show how to use Autosuggest, see Search using AutoSuggest.

AutoSuggest Client

The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively.

Computer Vision Client

The Bing Custom Image Search API lets you send an image search query to Bing and get back image search results customized to meet your custom search definition.

Custom Image Search Client

The Bing Custom Search API lets you send a search query to Bing and get back search results customized to meet your custom search definition.

Custom Search Client

The Entity Search API lets you send a search query to Bing and get back search results that include entities and places. Place results include restaurants, hotel, or other local businesses. For places, the query can specify the name of the local business or it can ask for a list (for example, restaurants near me). Entity results include persons, places, or things. Place in this context is tourist attractions, states, countries, etc.

Entity Search Client

The Image Search API lets you send a search query to Bing and get back a list of relevant images. This section provides technical details about the query parameters and headers that you use to request images and the JSON response objects that contain them. For examples that show how to make requests, see Searching the Web for Images.

Image Search Client

The Local Search client lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses. The query can specify the name of the local business or it can ask for a list (for example, restaurants near me).

Local Search Client

The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see Searching the web for news.

News Search Client

Custom Vision Prediction Client

The Spell Check API - V7 lets you check a text string for spelling and grammar errors.

Spell Check Client

Custom Vision Training Client

The Video Search API lets you search on Bing for video that are relevant to the user's search query, for insights about a video or for videos that are trending based on search requests made by others. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see Searching the Web for Videos.

Video Search Client

Visual Search API lets you discover insights about an image such as visually similar images, shopping sources, and related searches. The API can also perform text recognition, identify entities (people, places, things), return other topical content for the user to explore, and more. For more information, see Visual Search Overview. NOTE: To comply with the new EU Copyright Directive in France, the Bing Visual Search API must omit some content from certain EU News sources for French users. The removed content may include thumbnail images and videos, video previews, and snippets which accompany search results from these sources. As a consequence, the Bing APIs may serve fewer results with thumbnail images and videos, video previews, and snippets to French users.

Visual Search Client

The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.

Web Search Client

The Labs64 NetLicensing RESTful API gives you access to NetLicensing’s core features. Authentication You authenticate to the NetLicensing API by providing your account credentials or simply use our demo account - demo:demo Find out more about Labs64 NetLicensing at netlicensing.io

Product

Applications

Learn

Tools

Misc

Developer tools APIs mock samples for your project