Companies

List a company's plan assignments

Changed on

Lists the plans assigned to a company, active first, then expired and revoked. Use status=active for the plans that currently give the company its benefits (for example, the membership that lets it post jobs). Cursor-paginated. Requires plans.read.

get/companies/{id}/plan-assignments

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/companies/{id}/plan-assignments
  • Auth: HTTP bearer

Path parameters

idstring required

The company's opaque object id: the id field returned by the company endpoints (e.g. p17xq4c2b9r5gz3e8j0r6t4k7m2n9d5w). This is NOT the slug or display name; passing a slug like antler returns 404. To look up a company by name or slug, use GET /v1/companies, POST /v1/companies/search, or POST /v1/companies/find-or-create and read the returned id.

Query parameters

cursorstring
limitinteger
status'active' | 'expired' | 'revoked'

Only return assignments in this status.

Response

A page of plan assignments.

object'list' required
urlstring required
hasMoreboolean required
nextCursorstring nullable required

Example response

{
  "url": "/v1/companies/{id}/plan-assignments"
}

Changes