Companies

Get Companies

GET https://api.binity.io/v1/companies

Get all companies of the authenticated account.

Headers

Name	Type	Description
Authorization	string	Bearer Token

200 Cake successfully retrieved.

{
  "companies":[
    {
      "uuid":"65acd802-e258-4d15-a6cc-cf4d7ab2895a",
      "name":"Company #1",
      "default":true,
      "company_type":"branch",
      "created_at":"2020-06-08T10:16:02.031+02:00",
      "updated_at":"2021-05-07T09:30:59.995+02:00"
    },
    {
      "uuid":"3f5920d1-eb5f-4996-80af-d20ce5444aba",
      "name":"Company #2",
      "default":false,
      "company_type":"branch",
      "created_at":"2020-10-06T09:20:04.960+02:00",
      "updated_at":"2020-10-06T09:20:04.960+02:00"
    }
  ],
  "meta":{
    "pagination":{
      "per_page":25,
      "total_pages":1,
      "total_objects":25,
      "links":{
        "first":"/v1/companies?page=1",
        "last":"/v1/companies?page=1"}
      }
    }
  }
}

Create Company

POST https://api.binity.io/v1/companies

Create a new company.

Headers

Name	Type	Description
Authorization	string	Bearer Token

Request Body

Name	Type	Description
name	string	Name of the company
company_type	string	Can either be 'branch' or 'industry'

200

{
  "company":{
    "uuid":"65acd802-e258-4d15-a6cc-cf4d7ab2895a",
    "name":"Company #1",
    "default":true,
    "company_type":"branch",
    "created_at":"2020-06-08T10:16:02.031+02:00",
    "updated_at":"2021-05-07T09:30:59.995+02:00"
  }
}

Get Company

GET https://api.binity.io/v1/companies/:uuid

Get data of a single company.

Headers

Name	Type	Description
Authorization	string	Bearer Token

200

{
  "company":{
    "uuid":"65acd802-e258-4d15-a6cc-cf4d7ab2895a",
    "name":"Company #1",
    "default":true,
    "company_type":"branch",
    "created_at":"2020-06-08T10:16:02.031+02:00",
    "updated_at":"2021-05-07T09:30:59.995+02:00"
  }
}

Update Company

PATCH https://api.binity.io/v1/companies/:uuid

Update data of a single company.

Headers

Name	Type	Description
Authorization	string	Bearer Token

200

{
  "company":{
    "uuid":"65acd802-e258-4d15-a6cc-cf4d7ab2895a",
    "name":"Company #1",
    "default":true,
    "company_type":"branch",
    "created_at":"2020-06-08T10:16:02.031+02:00",
    "updated_at":"2021-05-07T09:30:59.995+02:00"
  }
}

Delete Company

DELETE https://api.binity.io/v1/companies/:uuid

Delete a single company and all of its assets.

Headers

Name	Type	Description
Authorization	string	Bearer Token

200

{
  "deleted": true
}