Calendly Contacts API is one of 18 APIs that Calendly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
7 operations
across 4 paths,
and defines 79 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://api.calendly.com.
The identity and technical contract details declared by the specification.
List-contact-custom-field-definitionsRequestNotFoundError
object
Error Object
3 properties
2 required
ContactsUuidPatchResponsesContentApplicationJsonSchemaTitle
string
InsufficientScopeError
object
Caller does not have required oauth scopes
3 properties
3 required
Delete-contacts-uuidRequestForbiddenError
Patch-contacts-uuidRequestUnauthorizedError
object
Error Object
3 properties
2 required
ContactsUuidGetResponsesContentApplicationJsonSchemaTitle
string
List-contactsRequestForbiddenError
ContactsPostResponsesContentApplicationJsonSchemaTitle
string
Get-contactRequestBadRequestError
object
Error Object
3 properties
2 required
ContactsUuidPatchRequestBodyContentApplicationJsonSchemaCustomFieldsItemsValue
The custom field value; the accepted type is set by the field definition's fieldtype. text and singleselect take a string (singleselect must equal one of the d…
Get-contactRequestForbiddenError
ContactsPostRequestBodyContentApplicationJsonSchemaCustomFieldsItemsValue
The custom field value; the accepted type is set by the field definition's fieldtype. text and singleselect take a string (singleselect must equal one of the d…
ContactCustomFieldDefinition
object
A custom field definition describes the schema for a field that can be applied to Contacts.
8 properties
5 required
Delete-contacts-uuidRequestNotFoundError
object
Error Object
3 properties
2 required
ContactsGetResponsesContentApplicationJsonSchemaTitle
string
Get-contact-custom-field-definitionRequestUnauthorizedError
object
Error Object
3 properties
2 required
Patch-contacts-uuidRequestNotFoundError
object
Error Object
3 properties
2 required
Patch-contacts-uuidRequestBadRequestError
object
Error Object
3 properties
2 required
PhoneNumber
object
A phone number associated with a contact.
1 property
1 required
Get-contact-custom-field-definitionRequestInternalServerError
object
Error Object
3 properties
2 required
ContactCustomFieldSource
object
Source metadata for system-generated fields, such as invitee questions.
3 properties
1 required
List-contactsRequestBadRequestError
object
Error Object
3 properties
2 required
Get-contactRequestUnauthorizedError
object
Error Object
3 properties
2 required
ContactsUuidGetResponsesContentApplicationJsonSchemaMessage
string
Create-contactRequestUnauthorizedError
object
Error Object
3 properties
2 required
Get-contact-custom-field-definitionRequestNotFoundError
object
Error Object
3 properties
2 required
Create-contactRequestBadRequestError
object
Error Object
3 properties
2 required
Contacts_create-contact_Response_201
object
1 property
1 required
ContactsErrorTitle
string
ContactsUuidDeleteResponsesContentApplicationJsonSchemaTitle
string
ContactsCustomFieldDefinitionsGetResponsesContentApplicationJsonSchemaMessage
string
Email
object
An email address for a contact. Exactly one entry in the emails array must have isprimary true.
2 properties
2 required
Contacts_list-contact-custom-field-definitions_Response_200
object
1 property
1 required
List-contactsRequestUnauthorizedError
object
Error Object
3 properties
2 required
Create-contactRequestInternalServerError
object
Error Object
3 properties
2 required
Delete-contacts-uuidRequestUnauthorizedError
object
Error Object
3 properties
2 required
List-contact-custom-field-definitionsRequestUnauthorizedError
object
Error Object
3 properties
2 required
List-contact-custom-field-definitionsRequestForbiddenError
Delete-contacts-uuidRequestInternalServerError
object
Error Object
3 properties
2 required
Contacts_patch-contacts-uuid_Response_200
object
1 property
1 required
Contacts_get-contact_Response_200
object
1 property
1 required
ContactsGetResponsesContentApplicationJsonSchemaMessage
string
Create-contactRequestForbiddenError
Create-contactRequestNotFoundError
object
Error Object
3 properties
2 required
ContactCustomFieldOption
object
4 properties
3 required
ContactCustomFieldSourceType
string
Delete-contacts-uuidRequestBadRequestError
object
Error Object
3 properties
2 required
ContactsErrorMessage
string
Get-contactRequestInternalServerError
object
Error Object
3 properties
2 required
List-contactsRequestInternalServerError
object
Error Object
3 properties
2 required
Contact
object
Information about a contact.
19 properties
4 required
List-contact-custom-field-definitionsRequestBadRequestError
object
Error Object
3 properties
2 required
Get-contactRequestNotFoundError
object
Error Object
3 properties
2 required
ContactCustomFieldDefinitionFieldType
string
Calendly custom field kind, which determines both input behavior and the expected value type.
ContactsError
object
Permission Denied
2 properties
2 required
ContactsUuidDeleteResponsesContentApplicationJsonSchemaMessage
string
ContactsPostRequestBodyContentApplicationJsonSchemaCustomFieldsItems
object
2 properties
2 required
ContactsUuidPatchResponsesContentApplicationJsonSchemaMessage
string
ErrorResponseDetailsItem
object
3 properties
1 required
InsufficientScopeErrorTitle
string
ContactsCustomFieldDefinitionsUuidGetResponsesContentApplicationJsonSchemaTitle
string
Patch-contacts-uuidRequestInternalServerError
object
Error Object
3 properties
2 required
Contacts_list-contacts_Response_200
object
2 properties
2 required
Patch-contacts-uuidRequestConflictError
object
Error Object
3 properties
2 required
ContactsCustomFieldDefinitionsGetResponsesContentApplicationJsonSchemaTitle
string
ContactsUuidPatchRequestBodyContentApplicationJsonSchemaCustomFieldsItems
object
2 properties
2 required
InsufficientScopeErrorMessage
string
Create-contactRequestConflictError
object
Error Object
3 properties
2 required
ContactCustomField
object
A custom field value on a Contact. uri is the custom field definition URI. label is derived from the custom field definition's name.
3 properties
2 required
Contacts_get-contact-custom-field-definition_Response_200
object
1 property
1 required
Get-contact-custom-field-definitionRequestForbiddenError
ContactCustomFieldValue
The custom field value; the accepted type is set by the field definition's fieldtype. text and singleselect take a string (singleselect must equal one of the d…
List-contact-custom-field-definitionsRequestInternalServerError
object
Error Object
3 properties
2 required
ContactsPostResponsesContentApplicationJsonSchemaMessage
string
Get-contact-custom-field-definitionRequestBadRequestError
object
Error Object
3 properties
2 required
List-contactsRequestNotFoundError
object
Error Object
3 properties
2 required
ContactsCustomFieldDefinitionsUuidGetResponsesContentApplicationJsonSchemaMessage
string
Patch-contacts-uuidRequestForbiddenError
Pagination
object
5 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Calendly publishes across the network.
