List invoice contacts

GET 
/api/invoice-contacts

List invoice contacts

Request

Query Parameters

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:

Equal

Usage: eq:{value}

Not equal

Usage: neq:{value}

Greater than

Usage: gt:{value}

Greater than or equal

Usage: gte:{value}

Less than

Usage: lt:{value}

Less than or equal

Usage: lte:{value}

In list

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

Not in list

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

Between

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

200

Returns the list of invoice contacts.

application/json

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

email stringrequired

Possible values: <= 50 characters

The contact email

alias stringrequired

Possible values: <= 50 characters

The contact alias

• ]

Example (from schema)

[
  {
    "id": 1,
    "created_at": "2026-03-27T11:39:28.133Z",
    "updated_at": "2026-03-27T11:39:28.133Z",
    "email": "contact@example.com",
    "alias": "Administration"
  }
]

400

Validation failed

application/json

Schema

Schema

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

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "precondition_failure",
  "message": "string"
}

Loading...