Get collection

GET 
/collections/:collection_id

note

This feature is only available in Preview to select customers on our Enterprise plan. Contact us for more information.

Returns a Collection object with the given id.

Request

Path Parameters

collection_id stringrequired
Example: 0258cbc6-6020-430a-848e-aafacbadf4ae

Query Parameters

include_raw_data boolean
Whether to include raw data fetched from the 3rd party provider.
Example: true

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

Responses

200

CollectionData

application/json

Schema

Schema

name stringnullablerequired
description stringnullable
collection_type stringnullable
parent_collection stringnullable
access_level stringnullable

Example (from schema)

{
  "name": "Q1 Platform",
  "description": "For tracking all tasks related to Platform for Q1",
  "collection_type": "LIST",
  "parent_collection": "681b0fd7-40e6-4b91-8e23-2814872090be",
  "access_level": "PUBLIC"
}

Loading...