API Documentation
Contact Entries ¶
GET /api/v2/contact_entries
Requests
GET /api/v2/contact_entries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "23",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "Personal",
"email": "contact1@email.com",
"phone": null,
"website": null,
"address": null,
"city": null,
"state": null,
"zipcode": null,
"country": null,
"vat": null,
"billing_address": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 148
}
},
"company": {
"data": {
"type": "companies",
"id": "484"
}
},
"person": {
"data": null
},
"invoice": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "24",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "Personal",
"email": "contact2@email.com",
"phone": null,
"website": null,
"address": null,
"city": null,
"state": null,
"zipcode": null,
"country": null,
"vat": null,
"billing_address": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 148
}
},
"company": {
"data": {
"type": "companies",
"id": "484"
}
},
"person": {
"data": null
},
"invoice": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
{
"id": "25",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "Personal",
"email": "contact3@email.com",
"phone": null,
"website": null,
"address": null,
"city": null,
"state": null,
"zipcode": null,
"country": null,
"vat": null,
"billing_address": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 148
}
},
"company": {
"data": {
"type": "companies",
"id": "484"
}
},
"person": {
"data": null
},
"invoice": {
"data": null
},
"subsidiary": {
"data": null
}
}
}
],
"included": [
{
"id": "484",
"type": "companies",
"attributes": {
"name": "Client335",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:43.402+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {
"emails": [
{
"name": "Personal",
"email": "contact1@email.com",
"contact_datum_id": 23
},
{
"name": "Personal",
"email": "contact2@email.com",
"contact_datum_id": 24
},
{
"name": "Personal",
"email": "contact3@email.com",
"contact_datum_id": 25
}
]
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 148
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/contact_entries?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/contact_entries?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 3,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get contact entriesGET/api/v2/contact_entries
GET /api/v2/contact_entries/1
Requests
GET /api/v2/contact_entries/26
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "26",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "Personal",
"email": "contact4@email.com",
"phone": null,
"website": null,
"address": null,
"city": null,
"state": null,
"zipcode": null,
"country": null,
"vat": null,
"billing_address": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 149
}
},
"company": {
"data": {
"type": "companies",
"id": "486"
}
},
"person": {
"data": null
},
"invoice": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "486",
"type": "companies",
"attributes": {
"name": "Client336",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:43.525+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {
"emails": [
{
"name": "Personal",
"email": "contact4@email.com",
"contact_datum_id": 26
}
]
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 149
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Gets a contact entryGET/api/v2/contact_entries/{id}
URI Parameters
- id
number
(required) Example: 1contact entry id
POST /api/v2/contact_entries
Requests
POST /api/v2/contact_entries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "Work",
"email": "contact@email.com"
},
"relationships": {
"company": {
"data": {
"type": "companies",
"id": "488"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "28",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "Work",
"email": "contact@email.com",
"phone": null,
"website": null,
"address": null,
"city": null,
"state": null,
"zipcode": null,
"country": null,
"vat": null,
"billing_address": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 150
}
},
"company": {
"data": {
"type": "companies",
"id": "488"
}
},
"person": {
"data": null
},
"invoice": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "488",
"type": "companies",
"attributes": {
"name": "Client337",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:43.618+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {
"emails": [
{
"name": "Personal",
"email": "contact5@email.com",
"contact_datum_id": 27
}
]
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 150
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/contact_entries
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "contact_entries",
"attributes": {
"type": ""
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/type"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/type"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/contactable_type"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not included in the list",
"source": {
"pointer": "data/attributes/contactable_type"
}
}
]
}
Create a contact entryPOST/api/v2/contact_entries
URI Parameters
- name
string
(required) Example: Namename
- type
string
(required) Example: Addresstype
- contactable_type
string
(required) Example: Clientcontactable type
PATCH /api/v2/contact_entries/1
Requests
PATCH /api/v2/contact_entries/38
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "contact_entries",
"attributes": {
"name": "new name"
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "38",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "new name",
"email": "contact12@email.com",
"phone": null,
"website": null,
"address": null,
"city": null,
"state": null,
"zipcode": null,
"country": null,
"vat": null,
"billing_address": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 157
}
},
"company": {
"data": {
"type": "companies",
"id": "500"
}
},
"person": {
"data": null
},
"invoice": {
"data": null
},
"subsidiary": {
"data": null
}
}
},
"included": [
{
"id": "500",
"type": "companies",
"attributes": {
"name": "Client342",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:03:44.567+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {
"emails": [
{
"name": "Personal",
"email": "contact12@email.com",
"contact_datum_id": 38
}
]
}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 157
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/contact_entries/39
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "contact_entries",
"attributes": {
"name": ""
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
Update a contact entryPATCH/api/v2/contact_entries/{id}
URI Parameters
- id
number
(required) Example: 1contact entry id
DELETE /api/v2/contact_entries/1
Requests
DELETE /api/v2/contact_entries/41
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
Deletes a contact entryDELETE/api/v2/contact_entries/{id}
URI Parameters
- id
number
(required) Example: 1contact entry id
Generated by aglio on 23 Jan 2021