Get specific contact
Get a specific contact by contact id.
curl --request GET \
--url http://localhost:3000/api/v1/contacts/{contactId}{
"contact": {
"id": "68234731e6074232892d18c4",
"companyName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"address": "<string>",
"postCode": "3700 Spiez",
"position": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"phone": "<string>",
"website": "<string>",
"category": "clients",
"formOfAddress": "<string>",
"note": "<string>",
"vatNumber": "<string>",
"country": "<string>",
"secondaryAddressLine": "<string>"
}
}Path Parameters
The id of the specific contact
Response
The contact is returned.
Represents a contact, such as a supplier, client, partner, lead, etc.
Show child attributes
Show child attributes
A unique hex identifier for the transaction.
"68234731e6074232892d18c4"
The company name associated with this contact.
For contacts which represent companies, this is used as the name of the contact.
48The given name of this contact.
48The surname of this contact.
48The main address line of the contact.
48The postal line text for this contact, including a ZIP code and place.
"3700 Spiez"
The position of the contact person within their company.
48The email address of the contact person. Must be a valid e-mail address or empty.
48The mobile phone number of the contact person.
24The phone number of the contact person.
24The website of this contact. Must be a valid URL.
128An optional category to associate this contact with.
clients, suppliers, partners, team, leads The form of address of the contact person, e.g. “Dr. med.“
24A custom plain-text note for this contact. May be multi-line.
2000An optional VAT registry number for this company. Is not validated for any specific format to allow entering values for formats of arbitrary countries.
24Display name of the country of this contact.
24An optional secondary address line for the location of this contact.
48curl --request GET \
--url http://localhost:3000/api/v1/contacts/{contactId}{
"contact": {
"id": "68234731e6074232892d18c4",
"companyName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"address": "<string>",
"postCode": "3700 Spiez",
"position": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"phone": "<string>",
"website": "<string>",
"category": "clients",
"formOfAddress": "<string>",
"note": "<string>",
"vatNumber": "<string>",
"country": "<string>",
"secondaryAddressLine": "<string>"
}
}