Smart Agent Teams
EndpointsCompanies

Get Company

Get one company, including the caller's membership `role`. Members only: a company the caller does not belong to answers 404 `NOT_FOUND`, so company ids cannot be probed.

GET
/api/companies/{company_id}

Get one company, including the caller's membership role.

Members only: a company the caller does not belong to answers 404 NOT_FOUND, so company ids cannot be probed.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

company_id*Company Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
created_at*|null
id*Id
Formatuuid
mission*string|null
monthly_budget_cents*Monthly Budget Cents
name*Name
role?string|null
task_prefix*Task Prefix
curl -X GET "https://example.com/api/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "created_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "mission": "string",  "monthly_budget_cents": 0,  "name": "string",  "role": "string",  "task_prefix": "string"}

Create Company POST

Create a company and make the caller its `owner`. `task_prefix` (default `SAT`, 1-8 characters, uppercase letters and digits, starting with a letter) forms task keys such as `SAT-12` and cannot be changed later. `monthly_budget_cents` is in integer cents; `0` means no limit. Records a `created` audit event.

Update Company PATCH

Update a company's `name`, `mission` or `monthly_budget_cents`. Requires the `owner` or `admin` role; other members get 403 `FORBIDDEN`, and non-members 404 `NOT_FOUND`. Only fields present in the body are changed; `task_prefix` cannot be changed. Money is in integer cents (`0` = no limit). When something changed, records an audit event and publishes `company.updated`.