GET /api/v2/roles
Personal access token & O auth2

Returns all roles for the authenticated firm.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [assignees].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    Filter by name (partial match).

  • sort string

    Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign for DESC.

  • per_page integer

    Number of results per page (Default 15. Max 500).

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
GET /api/v2/roles 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/roles' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (401) 
{
  "message": "Unauthenticated."
}