Get a client
GET/api/clients/:id
Required permissions:
- crm.view: allows view all resources.
Here the dedicated support page.
Request
Path Parameters
id stringrequired
Header Parameters
Wethod-Company stringrequired
The company you want to interact with
Wethod-Version stringrequired
The API version you want to use
Responses
- 200
- 403
- 404
Returns the requested client.
- application/json
- Schema
- Example (from schema)
Schema
id integerrequired
Possible values: >= 1
created_at date-timerequired
updated_at date-timerequired
corporate_name stringrequired
acronym string
email string
notes string
website string
linkedin string
description string
street string
zip_code string
town string
province string
country string
vat string
payment_condition string
group_company int
Possible values: >= 1
sdi_code string
pec string
administration_email string
company_registration_number string
legal_name string
intent_code string
intent_date date
Declaration of intent date
phone string
tax_reference string
group int
Possible values: >= 1
bank_account int
Possible values: >= 1
vat_rate int
Possible values: >= 1
payment_term int
Possible values: >= 1
{
"id": 1,
"created_at": "2024-12-20T14:44:08.101Z",
"updated_at": "2024-12-20T14:44:08.101Z",
"corporate_name": "First client",
"acronym": "First client acronym",
"email": "example@example.com",
"notes": "Some notes",
"website": "https://example.com",
"linkedin": "https://linkedin.com/in/example",
"description": "A brief description",
"street": "123 Main St",
"zip_code": "12345",
"town": "Townsville",
"province": "Province",
"country": "United States",
"vat": "123456789",
"payment_condition": "Payment terms",
"group_company": 1,
"sdi_code": "SDI12345",
"pec": "pec@example.com",
"administration_email": "admin@example.com",
"company_registration_number": "1234567890",
"legal_name": "Legal Name",
"intent_code": "Intent Code",
"intent_date": "2024-01-01",
"phone": "123-456-7890",
"tax_reference": "Tax Reference",
"group": 1,
"bank_account": 1,
"vat_rate": 1,
"payment_term": 1
}
Forbidden
Not found
Loading...