company

Get Many Companies

Securitybearer

Request

query Parameters

select	Array of strings Select Company fields, comma-separated. (e.g. `select=id,firstName,lastName,workEmail`) Items Value: "id"
	object Filters conditions per field. (e.g. `filters[id][$eq]=507f1f77bcf86cd799439011`)
limit	integer Limit amount of received Companies. (e.g. `limit=20`)
offset	integer Offset amount of received Companies. (e.g. `offset=20`)
	object Sort received Companies by field. (e.g. `sort[id]=asc`)

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/company

Response samples

application/json

{"status": "ok",
"data": [{"id": "string",
"name": "string",
"orgNumber": "string",
"billableUsers": 0,
"vatNumber": "string",
"phone": "string",
"email": "string",
"legalName": "string",
"logoUrl": "string",
"backgroundUrl": "string",
"offboardDate": "string"
}
],
"total": 500,
"count": 50,
"offset": 50,
"relations": { }
}

Get One Company

Securitybearer

Request

path Parameters

required

string

Resource Id

Example: 507f1f77bcf86cd799439011

query Parameters

select

Array of strings

Select Company fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Value: "id"