Companies

Get a company by company id

Lookup the details for an individual company using the specified company id. This method requires the Companies:Get permission to be associated with your role.

GET

/gb/companies/{company_id}

curl --request GET \
  --url https://api.catch-e.com/gb/companies/{company_id} \
  --header 'Authorization: <api-key>'

{
  "_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>"
}

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

Path Parameters

company_idstringrequired

Company Id to lookup

Maximum string length: 3

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

_linksobject

Show child attributes

abnstring

address1string

address2string

citystring

company_idstring

Example: 1

default_flagstring

email_financestring

faxstring

mobilestring

namestring

Example: Example Company

phonestring

postal_address1string

postal_address2string

postal_citystring

postal_postcodestring

postal_statestring

postcodestring

statestring

Still need help? Ask the team