Skip to main content
GET
/
companies
Retrieve Companies
curl --request GET \
  --url https://api.nuwebgroup.com/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "companies",
      "id": 1,
      "attributes": {
        "name": "My Ticket Co",
        "alias": "myticketco",
        "createdAt": "2023-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z"
      },
      "links": {
        "self": "http://api.willms.com/v1/company?id=5"
      }
    }
  ],
  "links": {
    "first": "http://api.willms.com/v1/companies?page=1",
    "last": "http://api.willms.com/v1/companies?page=5",
    "prev": "http://api.willms.com/v1/companies?page=2",
    "next": "http://api.willms.com/v1/companies?page=4",
    "self": "http://api.willms.com/v1/companies?page=3"
  },
  "meta": {
    "total": 50
  }
}

Authorizations

​
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

​
offset
integer

The offset - e.g 100 for listing companies starting with the 100th company. Offset will always take precedence over page.

​
page
integer

The page you wish to retrieve companies for. You can only paginate by page if no offset is given.

​
limit
integer

The number of companies to retrieve per page. The maximum (and default) is 100 per page.

​
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. companies.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

​
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. companies.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successfully retrieved the companies.

​
data
object[]
​
links
object
​
meta
object
​
included
object[]