Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

company

Must be System Admin - Search companies

post/app/v1/companies/search

Query parameters

tenant_idstring

Tenant ID for admin users

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'id' | 'name' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc"
}

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6
}