Manage Companies within the Privacy Bee ecosystem.

Permission: Access to this Business API – Company requires ‘read’ on the settings permission”

• GET /
• GET /roles
• GET /sites
• GET /sites/<id>

GET /

Get detailed information on your company.

Parameters: None

Example Request

curl -X GET "https://api.privacybee.com/companies/{{COMPANY_ID}}" -H "Accept: application/json"

Return: Company object

Example

{
  "id": 121579,
  "name": "Acme Data",
  "status": "enabled",
  "url": "https://www.acmedata.com",
  "logo": "",
  "scanner": true
}

---

GET /roles

Get the roles available to your company to be used when creating and updating employees.

Parameters: None

Example Request

curl -X GET "https://api.privacybee.com/companies/{{COMPANY_ID}}/roles" -H "Accept: application/json"

Return: Array<Role> of the roles available that can be used when updating employees.

Example

{
    {
      "name": "HR Manager",
      "permissions": ["write financial", "read financial"]
    },
    {
      "name": "Finance Analyst",
      "permissions": ["read financial"]
    },
    {
      "name": "IT Support",
      "permissions": ["write technical", "read technical"]
    }
}

---

GET /sites

Will return all people search sites and the current status of the scanner

Parameters: None

Example Request

curl -X GET "https://api.privacybee.com/{{COMPANY_ID}}/sites" -H "Accept: application/json"

Return: Array <Company> objects

Example

[
  {
    "id": 121579,
    "name": "Acme Data",
    "status": "enabled",
    "url": "https://www.acmedata.com",
    "logo": "",
    "scanner": true
  }
]
#This array contains a single object with the company’s details.

---

GET /site/<id>

Parameters: ID of the people search company you are searching for

Example Request

curl -X GET "https://api.privacybee.com/{{COMPANY_ID}}/sites/123" -H "Accept: application/json"

Variable	Data Type	Required	Description
id	unsigned integer	Yes	The unique identifier of the people search company you are searching for.

Return: Company object

Example

{
  "id": 121579,
  "name": "Acme Data",
  "status": "enabled",
  "url": "https://www.acmedata.com",
  "logo": "",
  "scanner": true 
}