API Documentation
Contact Entries ¶
Contact Entries ¶
Supported filter params
-
person_id (array)
-
company_id (array)
-
invoice_id (array)
-
subsidiary_id (array)
-
contactable_id (array)
-
contactable_type (array)
Contactable types
The contactable_type
attribute can have one of the following string values:
-
Person (used for contacts or users)
-
Client (used for companies)
-
Invoice (used for bill_from/bill_to on invoices)
-
Proposal (used for proposal_from/proposal_to on proposals)
-
Subsidiary
-
Purchase order
Contact entry types
The type
attribute can have one of the following string values:
-
Address
-
BillFrom
-
BillTo
-
Email
-
Phone
-
ProposalFrom
-
ProposalTo
-
Website
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
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "41",
"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": "226"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
},
{
"id": "42",
"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": "226"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
},
{
"id": "43",
"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": "226"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/contact_entries?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/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
}
}
Get contact entriesGET/api/v2/contact_entries
GET /api/v2/contact_entries/44
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
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "44",
"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": "227"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Gets a contact entryGET/api/v2/contact_entries/{id}
- id
number
(required) Example: 1contact entry id
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": "581"
}
}
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "46",
"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": "228"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
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": ""
}
}
}
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
- name
string
(required) Example: Namename
- type
string
(required) Example: Addresstype
- contactable_type
string
(required) Example: Clientcontactable type
PATCH /api/v2/contact_entries/58
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"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "58",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "new name",
"email": "contact13@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": "237"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/contact_entries/59
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": ""
}
}
}
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"
}
}
]
}
PATCH /api/v2/contact_entries/61
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"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "61",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "new name",
"email": "contact16@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": "240"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/contact_entries/62
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"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "62",
"type": "contact_entries",
"attributes": {
"contactable_type": "company",
"type": "email",
"name": "new name",
"email": "contact17@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": "241"
}
},
"company": {
"meta": {
"included": false
}
},
"person": {
"meta": {
"included": false
}
},
"invoice": {
"meta": {
"included": false
}
},
"subsidiary": {
"meta": {
"included": false
}
},
"purchase_order": {
"meta": {
"included": false
}
},
"invoice_template": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Update a contact entryPATCH/api/v2/contact_entries/{id}
- id
number
(required) Example: 1contact entry id
DELETE /api/v2/contact_entries/63
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
Deletes a contact entryDELETE/api/v2/contact_entries/{id}
- id
number
(required) Example: 1contact entry id
Generated by aglio on 26 Jul 2025