Companies

Get a list of configured companies

This method requires the Companies:Get permission to be associated with your role.

GET

/gb/companies

curl --request GET \
  --url 'https://api.catch-e.com/gb/companies?page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "company": [
      {
        "_links": {
          "self": {
            "href": "https://api.catch-e.com/gb/companies/1"
          }
        },
        "abn": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "company_id": 1,
        "default_flag": "<string>",
        "email_finance": "<string>",
        "fax": "<string>",
        "mobile": "<string>",
        "name": "Example Company",
        "phone": "<string>",
        "postal_address1": "<string>",
        "postal_address2": "<string>",
        "postal_city": "<string>",
        "postal_postcode": "<string>",
        "postal_state": "<string>",
        "postcode": "<string>",
        "state": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gb/companies"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team