Skip to content

Organizations

Organizations are the top-level tenant entity. Every target, accepted item, API key, and local usage record belongs to an organization.

Get Organization

GET /api/v1/orgs

Returns the organization associated with the current API key or session.

Response

json
{
  "org": {
    "id": "7a337feef0633bcfa20ae1b0ba3e0372",
    "name": "My Company",
    "slug": "7a337feef0633bcfa20ae1b0ba3e0372",
    "billing_status": "exempt",
    "billing_grace_ends_at": null,
    "created_at": 1787736000
  }
}

Update Organization

PATCH /api/v1/orgs

Request Body

json
{
  "name": "My Company Inc."
}

Response

json
{
  "updated": true
}

Released under the MIT License.