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 integerrequired

    Possible values: Value must match regular expression [0-9]+

    The ID of the client to view

Query Parameters

    include string

    Possible values: [externalIdentifiers]

    Include one or more relations in the response, separated by commas.

    When available, use dot-notation to retrieve nested relations.

    You can request any level of a nested relation, (e.g. relation or relation.nested or relation.nested.deeplyNested).

    deleted string

    Possible values: [exclude, include, only]

    Default value: exclude

    Filter items by deletion status.

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

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    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

    external_identifiers

    object[]

    The list of external identifiers associated with this client

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    external_id stringrequired

    The identifier of the resource on the external system

    type stringrequired

    The type/source of the external identifier

  • ]

    • deleted_at date-time

    The date and time when the resource was deleted

Loading...