latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

companies

List available Companies

get/v1/companies

Query parameters

type'client' | 'firm'

Whether the company is a Firm (the audit provider) or a Client.

Filter to show companies of a specific type

uuidsstring[]

Filter Companies by UUID. Repeat the query parameter for multiple UUIDs.

pagenumber nullable

per_pagenumber nullable

sort_order'asc' | 'desc'

Sort order for paginated results. Use desc to reverse the default ascending order.

Response

The Companies accessible by the user

Example response

{
  "data": [
    {
      "uuid": "3699af0f-9b92-410d-945c-bb0bf39da904",
      "name": "Jones Group, Inc.",
      "identifier": "CA0001-A",
      "_links": {
        "fieldguide": {
          "href": "https://example.com/resource/or/path",
          "title": "A description for the link",
          "type": "text/html"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.fieldguide.io/v1/example?page=2&per_page=50"
    },
    "first": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "last": {
      "href": "https://api.fieldguide.io/v1/example?page=10&per_page=50"
    },
    "previous": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "next": {
      "href": "https://api.fieldguide.io/v1/example?page=3&per_page=50"
    }
  }
}