Get a client

GET 
/api/clients/:id

Required permissions:

• crm.view: allows view all resources.

Here the dedicated support page.

Request

Path Parameters

id integerrequired

The ID of the client to view

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested client.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

created_at date-timerequired
updated_at date-timerequired
corporate_name stringrequired

Possible values: <= 255 characters

acronym string

Possible values: <= 50 characters

email string

Possible values: <= 80 characters

notes string
website string

Possible values: <= 250 characters

linkedin string

Possible values: <= 250 characters

description string
street string

Possible values: <= 80 characters

zip_code string

Possible values: <= 80 characters

town string

Possible values: <= 80 characters

country string

Possible values: <= 80 characters

vat string

Possible values: <= 80 characters

payment_condition string
group_company int

Possible values: >= 1

sdi_code string
pec string

Possible values: <= 320 characters

administration_email string

Possible values: <= 320 characters

company_registration_number string
legal_name string

Possible values: <= 255 characters

intent_code string

Possible values: <= 250 characters

intent_date date

Declaration of intent date

phone string
tax_reference string
group_id int

Possible values: >= 1

bank_account_id int

Possible values: >= 1

vat_rate_id int

Possible values: >= 1

payment_term_id int

Possible values: >= 1

Example (from schema)

{
  "id": 1,
  "created_at": "2025-04-22T10:10:02.280Z",
  "updated_at": "2025-04-22T10:10:02.280Z",
  "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",
  "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_id": 1,
  "bank_account_id": 1,
  "vat_rate_id": 1,
  "payment_term_id": 1
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "message": "string"
}

Loading...