v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Companies

This API endpoint retrieves the list of companies.<br><br>You can use the query params to filter a subset of companies who match specific field values.

get/v1/companies

Query parameters

namestring

The name of the company to query for.

isPlaceholderboolean

If true, filter for all placeholder companies. If false, filter for all non-placeholder companies. If not provided, return all companies.

nextTokenstring

limitinteger

Response

200

nextTokenstring

Example response

{
  "data": [
    {
      "id": "b3be03e0-4e92-4483-997e-f6c351bfbd34",
      "object": "company",
      "createdAt": "2024-02-14T22:41:58.09460254Z",
      "name": "RocketRides4",
      "fallbackColor": "#7CAE7A"
    }
  ],
  "nextToken": "eyJwa2V5IjoiODc2NjdkY2ItNjcxNC00ZmNkLWJjNGUtNDI0ZGUxMzNiZjYyIiwic2tleSI6IkNMSUVOVF9DT01QQU5ZIiwiZGF0YSI6InVzLWVhc3QtMV9xbEFSQlE5bUYvZGVmYXVsdC9iMTRlZmJlOC03Y2U3LTRjNDEtYTdhNC0yMzczMTNmYzgxZDMifQ=="
}