Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
A valid request URL is required to generate request examples{
"id": 16,
"name": "iPear",
"data": {
"address": {
"value": [
{
"id": 16,
"city": "San Francisco",
"name": "South Office",
"phone": "+1234567890",
"state": "California",
"country": "USA",
"contacts": {
"value": [
{
"id": 18,
"name": "John Doe",
"note": "Cool",
"email": "john@example.com",
"phone": "+123456789",
"position": "Highlifter",
"priority": "standard"
},
{
"id": 19,
"name": "Jane Doe",
"note": null,
"email": "jane@example.com",
"phone": "+123456789",
"position": "CEO",
"priority": "standard"
}
]
},
"priority": "standard",
"post_code": "1111111",
"address_line_1": "Hills",
"address_line_2": "23",
"team_region_id": null
}
]
},
"company_details": {
"value": {
"email": "ipear@example.com",
"status": "Approved",
"website": "example.com",
"language": "en",
"password": "SeCR34",
"user_name": "Dim Hook",
"company_name": "iPear"
}
}
},
"addresses": [
{
"id": 16,
"name": "South Office",
"phone": "+1234567890",
"postcode": "1111111",
"address_line_1": "Hills",
"address_line_2": "23",
"city": "San Francisco",
"state": "California",
"country": "USA"
}
],
"people": [
{
"id": 18,
"name": "John Doe",
"email": "john@example.com",
"phone": "+123456789",
"position": "Highlifter",
"note": "Cool"
},
{
"id": 19,
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+123456789",
"position": "CEO",
"note": null
}
],
"categories": [
{
"id": 1,
"type": "client"
}
]
}{
"error": "Bad Request: <description>"
}{
"error": "Unauthorized"
}{
"error": "Forbidden"
}creates a contact
A valid request URL is required to generate request examples{
"id": 16,
"name": "iPear",
"data": {
"address": {
"value": [
{
"id": 16,
"city": "San Francisco",
"name": "South Office",
"phone": "+1234567890",
"state": "California",
"country": "USA",
"contacts": {
"value": [
{
"id": 18,
"name": "John Doe",
"note": "Cool",
"email": "john@example.com",
"phone": "+123456789",
"position": "Highlifter",
"priority": "standard"
},
{
"id": 19,
"name": "Jane Doe",
"note": null,
"email": "jane@example.com",
"phone": "+123456789",
"position": "CEO",
"priority": "standard"
}
]
},
"priority": "standard",
"post_code": "1111111",
"address_line_1": "Hills",
"address_line_2": "23",
"team_region_id": null
}
]
},
"company_details": {
"value": {
"email": "ipear@example.com",
"status": "Approved",
"website": "example.com",
"language": "en",
"password": "SeCR34",
"user_name": "Dim Hook",
"company_name": "iPear"
}
}
},
"addresses": [
{
"id": 16,
"name": "South Office",
"phone": "+1234567890",
"postcode": "1111111",
"address_line_1": "Hills",
"address_line_2": "23",
"city": "San Francisco",
"state": "California",
"country": "USA"
}
],
"people": [
{
"id": 18,
"name": "John Doe",
"email": "john@example.com",
"phone": "+123456789",
"position": "Highlifter",
"note": "Cool"
},
{
"id": 19,
"name": "Jane Doe",
"email": "jane@example.com",
"phone": "+123456789",
"position": "CEO",
"note": null
}
],
"categories": [
{
"id": 1,
"type": "client"
}
]
}{
"error": "Bad Request: <description>"
}{
"error": "Unauthorized"
}{
"error": "Forbidden"
}