API Explorer

Send real HTTP requests for all Unified APIs without implementing any code or updating environment configurations.

Authorization

API Key*String
Grab your API key from the application settings

Header parameters

x-apideck-consumer-id*string

ID of the consumer which you want to get or push data from

x-apideck-app-id*string

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

cursorstring or null

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

limitinteger

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobject
company_idstring

Company ID to filter on

owner_idstring

Owner ID to filter on

contact_idstring

Primary contact ID to filter on

updated_sincestring
typestring

Type to filter on

sortobject
bystring

The field on which to sort the Activities

directionstring

The direction in which to sort the results

pass_throughobject
example_downstream_propertystring

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

property name*any
fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Request

 // Enter your API Key and required params.