Companies

Overview

Lists companies the authenticated user belongs to that have an active Pro plan. Upgrade at https://app.animo.co/admin/settings/billing.

Use the returned id (sqid) as the {company} path parameter for all API endpoints.
Use the returned slug when constructing public URLs (e.g. https://app.animo.co/{slug}/event/...).

If your companies are on Free or Business plans, this endpoint returns 200 with data: [] — not 403. That usually means the plan needs upgrading, not that your token is wrong.

Endpoints

List companies

Method: GET
Path: /api/v1/companies
Scope: companies:read
Subscription: Pro plan (USE_API) — company must be on Pro to appear in the list

Path parameters

None.

Query parameters

None.

Response `200`

{
  "data": [
    {
      "id": "c9Xk2",
      "created_at": "2025-03-10T14:00:00.000+00:00",
      "backdrop": "https://example.com/backdrop.jpg",
      "backdrop_mobile": "https://example.com/backdrop-mobile.jpg",
      "brand_color": "#FF5500",
      "linkedin_url": "https://linkedin.com/company/acme",
      "privacy_policy": "https://example.com/privacy",
      "logo": "https://example.com/logo.png",
      "name": "Acme Events",
      "slug": "acme-events",
      "tagline": "Events that connect",
      "url": "https://acme.example.com"
    }
  ],
  "links": { "...": "..." },
  "meta": { "...": "..." }
}

Response fields

Field	Type	Description
`id`	string	Company sqid — use as `{company}` in URLs
`created_at`	string	ISO 8601 timestamp
`backdrop`	string\|null	Desktop backdrop image URL
`backdrop_mobile`	string\|null	Mobile backdrop image URL
`brand_color`	string	Hex brand color
`linkedin_url`	string\|null	Company LinkedIn URL
`privacy_policy`	string\|null	Privacy policy URL
`logo`	string\|null	Logo image URL
`name`	string	Company name
`slug`	string	URL slug
`tagline`	string\|null	Company tagline
`url`	string\|null	Company website URL

Errors

Status	When
`401`	Missing or invalid token
`403`	Token missing `companies:read` scope

​Companies

​Overview

​Endpoints

​List companies

​Path parameters

​Query parameters

​Response 200

​Response fields

​Errors

​Related