v1

latestOpenAPI 3.0.0Apache 2.02026-07-13104382.5 KB

API Resources

Get API Resource

get/connector/apis/{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.

Headers

x-apideck-app-idstring required

The ID of your Unify application

Response

ApiResources

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",
    "linked_resources": [
      {
        "id": "companies",
        "unified_property": "owner_id"
      }
    ],
    "schema": {
      "required": [
        "name",
        "company_name"
      ],
      "x-pii": [
        "name",
        "email",
        "first_name",
        "last_name"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "example": "12345",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "example": "Elon Musk",
          "minLength": 1
        },
        "updated_at": {
          "type": "string",
          "example": "2020-09-30T07:43:32.000Z",
          "readOnly": true
        },
        "created_at": {
          "type": "string",
          "example": "2020-09-30T07:43:32.000Z",
          "readOnly": true
        }
      }
    }
  },
  "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"
  }
}