| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Id |
string | ➖ | ID of the resource, typically a lowercased version of name. | companies |
Name |
string | ➖ | Name of the resource (plural) | Companies |
DownstreamId |
string | ➖ | ID of the resource in the Connector's API (downstream) | accounts |
DownstreamName |
string | ➖ | Name of the resource in the Connector's API (downstream) | Accounts |
Status |
ResourceStatus | ➖ | Status of the resource. Resources with status live or beta are callable. | |
PaginationSupported |
bool | ➖ | Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource. | |
Pagination |
PaginationCoverage | ➖ | N/A | |
CustomFieldsSupported |
bool | ➖ | Indicates if custom fields are supported on this resource. | |
SupportedOperations |
List<string> | ➖ | List of supported operations on the resource. | [ "all", "one", "add", "update", "delete" ] |
DownstreamUnsupportedOperations |
List<string> | ➖ | List of operations that are not supported on the downstream. | [ "upload" ] |
SupportedFilters |
List<string> | ➖ | Supported filters on the list endpoint of the resource. | [ "name", "email" ] |
SupportedSortBy |
List<string> | ➖ | Supported sorting properties on the list endpoint of the resource. | [ "updated_at", "created_at", "name" ] |
SupportedFields |
List<SupportedProperty> | ➖ | Supported fields on the detail endpoint. | |
SupportedListFields |
List<SupportedProperty> | ➖ | Supported fields on the list endpoint. |