List clients

GET /api/clients

Required permissions:

crm.view: allows view all resources.

Here the dedicated support page.

Request

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).

limit integer

Possible values: >= 1 and <= 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.

Operators:

Usage: eq:{value}

Usage: neq:{value}

Usage: gt:{value}

Usage: gte:{value}

Usage: lt:{value}

Usage: lte:{value}

Usage: in:{value_1},{value_2},{value_3}

Usage: nin:{value_1},{value_2},{value_3}

Description: The given values are inclusive.

Usage: bt:{value_min},{value_max}

deleted string

Possible values: [exclude, include, only]

Default value: exclude

Filter items by deletion status.

deleted_at date-time

Filter items by the deleted_at field.

Operators:

Usage: eq:{value}

Usage: neq:{value}

Usage: gt:{value}

Usage: gte:{value}

Usage: lt:{value}

Usage: lte:{value}

Usage: in:{value_1},{value_2},{value_3}

Usage: nin:{value_1},{value_2},{value_3}

Description: The given values are inclusive.

Usage: bt:{value_min},{value_max}

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

application/json

Schema
Example (from schema)

Schema

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

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

]

[
  {
    "id": 1,
    "created_at": "2026-05-15T17:08:59.529Z",
    "updated_at": "2026-05-15T17:08:59.529Z",
    "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,
    "external_identifiers": [
      {
        "id": 1,
        "created_at": "2026-05-15T17:08:59.529Z",
        "updated_at": "2026-05-15T17:08:59.529Z",
        "external_id": "SF-0001",
        "type": "string"
      }
    ],
    "deleted_at": "2026-05-15T17:08:59.529Z"
  }
]

Validation failed

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

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

]

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "string",
  "message": "string"
}

Precondition failed

application/json

Schema
Example (from schema)

Schema

headers

object

oneOf

ResponseHeaderBag

content string

version string

status_code integer

status_text string

charset string

callback string

encoding_options integer

Default value: 64

key string

Error unique key

message string

Human-readable message describing the error

{
  "headers": {},
  "content": "string",
  "version": "string",
  "status_code": 0,
  "status_text": "string",
  "charset": "string",
  "callback": "string",
  "encoding_options": 64,
  "key": "precondition_failure",
  "message": "string"
}

List clients

/api/clients

Request​

Query Parameters

Header Parameters

Responses​

Request

Responses