List companies

GET 
/companies

List companies

Request

Query Parameters

offset number

Default value: 0

limit number

Possible values: >= 1 and <= 1000

Default value: 10

Responses

200

sucess - a paginated list of companies

application/json

Schema

Schema

• Array [

id stringrequired

Unique identifier of the company

name stringnullablerequired

Name of the company

specific

object

nullable

required

Value specific to the company with arbitrary structure

nullable

• ]

Example (from schema)

[
  {
    "id": "adfdfaca-48f0-4f3b-b30a-c6d97293090c",
    "name": "Apple Paris",
    "specific": {
      "customField": "customValue"
    }
  }
]

Loading...