Sign in
Connector Resources

Get Connector Resource

Get Connector Resource

get/connector/connectors/{id}/resources/{resource_id}

Path parameters

idstring required

ID of the record you are acting upon.

resource_idstring required

ID of the resource you are acting upon.

Query parameters

unified_api'accounting' | 'ats' | 'calendar' | 'crm' | 'csp' | 'customer-support' | 'ecommerce' | 'email' | 'email-marketing' | 'expense-management' | 'file-storage' | 'form' | 'hris' | 'lead' | 'payroll' | 'pos' | 'procurement' | 'project-management' | 'script' | 'sms' | 'spreadsheet' | 'subscription-analytics' | 'team-messaging' | 'issue-tracking' | 'time-registration' | 'transactional-email' | 'vault' | 'data-warehouse'

Name of Apideck Unified API

Example:crm

Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs

Headers

x-apideck-app-idstring required

The ID of your Unify application

Response

ConnectorResources

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": {
    "id": "companies",
    "name": "Companies",
    "downstream_id": "accounts",
    "downstream_name": "Accounts",
    "pagination": {
      "mode": "native"
    },
    "supported_operations": [
      "all",
      "one",
      "add",
      "update",
      "delete"
    ],
    "downstream_unsupported_operations": [
      "upload"
    ],
    "supported_filters": [
      "name",
      "email"
    ],
    "supported_sort_by": [
      "updated_at",
      "created_at",
      "name"
    ],
    "supported_fields": [
      {
        "unified_property": "owner_id"
      }
    ],
    "supported_list_fields": [
      {
        "unified_property": "owner_id"
      }
    ]
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Changes

Changed in 4 of the 65 revisions of this API.123

  • 4fa24035e0871See the full diff
    • ○

      added the optional property meta/warnings to the response with the 200 status

      response-optional-property-added

  • 1cd29f012f6d1See the full diff
    • ○

      added the optional property meta/total_count to the response with the 200 status

      response-optional-property-added

  • 6438d72077611See the full diff
    • ○

      added the new enum value subscription-analytics to the query request parameter unified_api

      request-parameter-enum-value-added

  • b460c649137b12See the full diff
    • ▲

      removed the enum value subscription-analytics from the query request parameter unified_api

      request-parameter-enum-value-removed

    • ●

      removed the optional property meta/total_count from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property meta/warnings from the response with the 200 status

      response-optional-property-removed