CAcardda
Company role

List company roles

Returns the custom roles defined for the company, each with its permissions (only id and name per permission). Supports the standard list query parameters.

get/v1/companies/{company_id}/company_roles

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/companies/{company_id}/company_roles
  • Auth
    HTTP bearer

Path parameters

company_idstring uuid required

The UUID of the company the nested resource belongs to.

Parameters

#/paths/~1v1~1users/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1users/get/parameters/1 (unresolved $ref)
#/paths/~1v1~1users/get/parameters/2 (unresolved $ref)
#/paths/~1v1~1users/get/parameters/3 (unresolved $ref)
#/paths/~1v1~1users/get/parameters/4 (unresolved $ref)

Response

Paginated list of company roles.

idstring uuid required
company_idstring uuid required
namestring required
descriptionstring nullable
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "name": "Finance",
    "permissions": [
      {
        "name": "cards_view"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.