Retrieve a single Custom Object Type | Close | Developer API Documentation

curl https://api.close.com/api/v1/custom_object_type/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "api_create_only": true,
  "back_reference_fields": [],
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "date_created": "2020-07-09T15:36:16.795350",
  "date_updated": "2020-07-09T15:36:16.795350",
  "description": "A Resource tracked by an external system.",
  "editable_with_roles": [],
  "fields": [
    {
      "accepts_multiple_values": true,
      "back_reference_is_visible": true,
      "description": "Account objects using this Resource.",
      "editable_with_roles": [],
      "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
      "name": "Linked Accounts",
      "referenced_custom_type_id": "cotype_4hQsScWF3hnUOyngoaAV00",
      "required": true,
      "type": "custom_object"
    }
  ],
  "id": "cotype_1h5m6uHM9BZOpwVhyRJb4Y",
  "name": "Resource",
  "name_plural": "Resources",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

Retrieve a single custom object type by ID. The response contains the Custom Object Type including most Custom Field metadata.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error