List clients

GET 
/api/clients

Required permissions:

• crm.view: allows view all resources.

Here the dedicated support page.

Request

Query Parameters

limit integer

Possible values: <= 100

Default value: 100

The number of items to include in the response.

offset integer

Default value: 0

The offset of the first returned item.

updated_at date-time

Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Examples:

On a date

Filter items updated on a date.

Example: 2024-01-01T20:00:00%2B02:00

Greater than

Filter items updated after a date.

Example: gt:2024-01-01T20:00:00%2B02:00

Lower than

Filter items updated before a date.

Example: lt:2024-01-01T20:00:00%2B02:00

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 list of clients

application/json

Schema

Schema

• Array [

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-02-13T09:26:18.353Z",
    "updated_at": "2025-02-13T09:26:18.353Z",
    "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

Bad request

Loading...