# List Clients

Returns the authenticated client together with all of its descendants. Only clients you can act
for are ever returned — never a parent, sibling, or unrelated client.

Results are paginated with the standard  /  query parameters; pagination
metadata is returned in the response headers.

Requires this feature to be enabled for your account (contact us); otherwise this endpoint responds with .


Endpoint: GET /v2/clients
Security: Bearer-Auth

## Query parameters:

  - `parent_id` (string)
    Return only the direct children of this client (its UUID). Must be the authenticated client or one of its descendants, otherwise  is returned.

  - `external_reference` (string)
    Return only the client with this exact .

  - `query` (string)
    Case-insensitive search across client name and .

  - `page` (number)
    Page number for pagination (starts at 1).

  - `per_page` (number)
    Number of clients per page. Falls back to the default when omitted or invalid.

## Response 200 fields (application/json):

  - `id` (string, required)
    The client's unique identifier (UUID). Use this value as a  or as the travel-data .

  - `name` (string,null)
    The client's display name.

  - `external_reference` (string,null)
    Your own reference for this client, unique among the children of a given parent. Generated from the name when omitted on creation.

  - `parent_id` (string,null, required)
    The UUID of this client's parent, or  for the authenticated (root) client.

  - `status` (string, required)
    The client's lifecycle status.
    Enum: "active"

  - `metadata` (object, required)
    A set of key-value pairs of yours that helps you link this record in your system.

  - `methodology_options` (array, required)
    The methodologies this client calculates with, one entry per activity type and methodology.
Always present: a client that has never been configured reports the SQUAKE defaults it
calculates with ( and  for flights,  for trains and cars,  for
hotels — all ).

Set it with the  object on  and
.

  - `methodology_options.activity_type` (string, required)
    The activity type this option applies to.
    Enum: "flight", "train", "car", "hotel"

  - `methodology_options.methodology` (string, required)
    The methodology used to calculate this activity type. Must be one of the methodologies available for the ; anything else is rejected with  ().

  - `methodology_options.version` (string,null)
    The methodology version to calculate with. Use  to always pick the
factor set that was valid on the travel date. Send  (or omit the field) to use the
methodology's current version.

Only , , , , and  publish selectable
versions; for the others the value is informational.

  - `methodology_options.default` (boolean, required)
    Whether this is the methodology reported for the activity type. Exactly one option per  must be . Required on every entry — an entry without a boolean  is rejected with  ().

## Response 401 fields (application/json):

  - `errors` (array)

  - `errors.code` (string, required)
    An application-specific error code, expressed as a string value.
    Enum: "field_validation_error", "invalid_params", "server_error", "not_authorized", "not_found", "invalid_methodology", "invalid_type", "client_not_found", "invalid_parent_client", "client_has_children", "parent_id_immutable", "travel_data_not_found"

  - `errors.detail` (string)
    A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

  - `errors.source` (object)
    An object containing references to the primary source of the error

  - `errors.source.id` (string)

  - `errors.source.attribute` (string, required)

  - `errors.source.model` (string)

## Response 404 fields (application/json):

  - `errors` (array)

  - `errors.code` (string, required)
    An application-specific error code, expressed as a string value.
    Enum: "field_validation_error", "invalid_params", "server_error", "not_authorized", "not_found", "invalid_methodology", "invalid_type", "client_not_found", "invalid_parent_client", "client_has_children", "parent_id_immutable", "travel_data_not_found"

  - `errors.detail` (string)
    A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

  - `errors.source` (object)
    An object containing references to the primary source of the error

  - `errors.source.id` (string)

  - `errors.source.attribute` (string, required)

  - `errors.source.model` (string)