Skip to main content

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​

Returns the requested client.

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

Loading...