Get all customers.

GET 
/v1/customers

Returns a paginated list of all customers. If no limit is provided, the default is value is used. By default the list gets ordered by the created_at field in descending order.

Request

Query Parameters

limit int64

Possible values: >= 1 and <= 100

Default value: 10

Number of items to return per page.

page int64

Possible values: >= 1

Default value: 1

Page number to return.

name string
Possible values: >= 3 characters and <= 80 characters
Name of the customer to search for.
Example: truvami ltd.

Responses

200

OK

application/json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

data

object[]

required

Array [

created_at date-timerequired

Date and time the customer was created.

name stringrequired

Possible values: non-empty and <= 80 characters

Name of customer.

updated_at date-timerequired

Date and time the customer was updated.

uuid uuidrequired

Unique identifier for the person

]

metadata

object

required

limit int64required

page int64required

total int64required

total_pages int64required
status int64required
timestamp date-timerequired

Example (from schema)

{
  "$schema": "string",
  "data": [
    {
      "created_at": "2024-05-16T15:52:03.545Z",
      "name": "string",
      "updated_at": "2024-05-16T15:52:03.545Z",
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "metadata": {
    "limit": 0,
    "page": 0,
    "total": 0,
    "total_pages": 0
  },
  "status": 0,
  "timestamp": "2024-05-16T15:52:03.545Z"
}

400

Bad Request

application/problem+json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

detail string

A human-readable explanation specific to this occurrence of the problem.

errors

object[]

Optional list of individual error details

Array [

location string

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

message string

Error message text

value

The value at the given location

]

instance uri

A URI reference that identifies the specific occurrence of the problem.

status int64

HTTP status code

title string

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

type uri

Default value: about:blank

A URI reference to human-readable documentation for the error.

Example (from schema)

{
  "$schema": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

401

Unauthorized

application/problem+json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

detail string

A human-readable explanation specific to this occurrence of the problem.

errors

object[]

Optional list of individual error details

Array [

location string

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

message string

Error message text

value

The value at the given location

]

instance uri

A URI reference that identifies the specific occurrence of the problem.

status int64

HTTP status code

title string

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

type uri

Default value: about:blank

A URI reference to human-readable documentation for the error.

Example (from schema)

{
  "$schema": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

403

Forbidden

application/problem+json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

detail string

A human-readable explanation specific to this occurrence of the problem.

errors

object[]

Optional list of individual error details

Array [

location string

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

message string

Error message text

value

The value at the given location

]

instance uri

A URI reference that identifies the specific occurrence of the problem.

status int64

HTTP status code

title string

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

type uri

Default value: about:blank

A URI reference to human-readable documentation for the error.

Example (from schema)

{
  "$schema": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

422

Unprocessable Entity

application/problem+json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

detail string

A human-readable explanation specific to this occurrence of the problem.

errors

object[]

Optional list of individual error details

Array [

location string

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

message string

Error message text

value

The value at the given location

]

instance uri

A URI reference that identifies the specific occurrence of the problem.

status int64

HTTP status code

title string

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

type uri

Default value: about:blank

A URI reference to human-readable documentation for the error.

Example (from schema)

{
  "$schema": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

500

Internal Server Error

application/problem+json

Schema

Schema

$schema uri

A URL to the JSON Schema for this object.

detail string

A human-readable explanation specific to this occurrence of the problem.

errors

object[]

Optional list of individual error details

Array [

location string

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

message string

Error message text

value

The value at the given location

]

instance uri

A URI reference that identifies the specific occurrence of the problem.

status int64

HTTP status code

title string

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

type uri

Default value: about:blank

A URI reference to human-readable documentation for the error.

Example (from schema)

{
  "$schema": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Loading...