Skip to content
/
List Clients

List Clients

Request

Gets a paginated list of client organizations tracked in the system, supporting filtering and searching for project association and reporting.

Security
ApiKey
Query
pageinteger, (int32)

The specific page of results requested.

page_sizeinteger, (int32)

The number of results in each page.

archivedboolean

Indicates if results should be filtered by their archived status.

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/clients?page=0&page_size=0&archived=true' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
countinteger, (int64)

The number of results in the current page.

totalinteger, (int64)

The total number of results that fulfill the request.

pageinteger, (int64)

The current page of results being returned.

total_pagesinteger, (int64)

The total number of available pages that fulfill the request.

page_sizeinteger, (int64)

The number of results in each page returned.

resultsArray of objects(Client)required

The array of result objects for the current page.

Response
{
  "count": 0,
  "total": 0,
  "page": 0,
  "total_pages": 0,
  "page_size": 0,
  "results": [
    { … }
  ]
}