v1

latestOpenAPI 3.0.02026-08-066924329.8 KB

Clients

Get all clients

post/clients/search

Request body

limitinteger

searchstring

idsstring[]

activeboolean nullable

withLimitedPartOfProjectsboolean nullable

Returns a limited number of projects within the clients data. If the parameter projectsLimit is not set, the limit parameter will be used.

projectsLimitinteger nullable

Sets a own limit of entries which will be returned with the returned clients. The Parameter withLimitedPartOfProjects must be set.

Example request

{
  "limit": 100,
  "search": "GmbH",
  "orders": [
    {
      "column": "id",
      "direction": "desc"
    }
  ],
  "withLimitedPartOfProjects": true,
  "projectsLimit": 25
}

Response

successful operation

Example response

{
  "data": [
    {
      "id": "<ULID>",
      "name": "Test GmbH",
      "ext_tool_id": 24,
      "info": "Some information about your Client.",
      "color": "#000000",
      "active": true,
      "acronym": "ACR",
      "image_id": "<ULID>",
      "demo_flag": true,
      "projects_count": 5,
      "active_projects_count": 5
    }
  ]
}