Skip to main content

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:

    Filter items updated on a date.

    Example: 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​

Returns the list of clients

Schema

  • Array [

    • 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

  • ]

Loading...