PlanRadar Roles V2 API

openapi: 3.2.0
info:
  title: PlanRadar's API Documentation Approval Requests V2 Roles V2 API
  version: '2.0'
  description: "Welcome to PlanRadar's API documentation, here you can find all the details about our APIs as well as test them online.<br />\n        <h5>Rate Limits</h5>30 requests per minute per account, aggregated across all tokens.<br />\n        If the threshold is exceeded, a 5-minute cooldown is applied to the account, aggregated across all tokens.<br />\n        During the cooldown period, further requests may be rejected until the cooldown ends.<br />\n        In rare cases, an endpoint may have a different rate limit than the default. When that happens, the differing limit will be explicitly stated in the API documentation for that endpoint.<br />\n        <h5>Access Key</h5>In order to be able to access any API you have to create an access token.Therefore you have to follow these steps:-\n        <ul>\n          <li>Go to your profile page and click on Personal Access Tokens on the left side bar</li><li>Click on the 'Create Access Token' top right button in order to create a new access token.</li><li>Copy the created token and paste it into the field that pops up when you click on the 'Authorize' button </li><li>Note: you can copy the token only once.</li><li>Now you can easily access any API</li>\n        </ul>\n        <h5>V2 APIs</h5>We are currently working on upgrading all our APIs to v2, and we recommend that you use v2 APIs if it is available.\n        <p>V2 APIs are faster, robust and more flexible than v1 APIs</p>"
servers:
- url: /
tags:
- name: Roles V2
  description: Manage roles defined in your account
paths:
  /api/v2/{customer_id}/roles:
    get:
      summary: Retrieve all roles for a customer
      tags:
      - Roles V2
      description: Returns all roles defined for the customer account. Supports pagination, search, sorting, and sync filtering. Each role includes a count-assigned-users attribute representing the number of distinct users assigned to that role across projects.
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
          default: '100000'
      - name: page
        in: query
        description: Page number for pagination
        schema:
          type: integer
      - name: pagesize
        in: query
        description: 'Number of roles per page (default: 100, max: 500)'
        schema:
          type: integer
      - name: last_sync_date
        in: query
        description: Unix timestamp. Only roles updated after this time are returned
        schema:
          type: string
      - name: search
        in: query
        description: Filter roles by name (case-insensitive)
        schema:
          type: string
      - name: sort
        in: query
        description: Sort field. Prefix with '-' for descending. e.g. 'name', '-created-on', 'is-admin-role'
        schema:
          type: string
      responses:
        '200':
          description: Roles Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                        attributes:
                          type: object
                          properties:
                            name:
                              type: string
                            updated-on:
                              type: string
                            created-on:
                              type: string
                            is-admin-role:
                              type: boolean
                            permissions:
                              type: object
                            count-assigned-users:
                              type: integer
                              description: Number of distinct users assigned to this role across projects
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                      page:
                        type: string
        '404':
          description: Customer Not Found
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-PlanRadar-API-Key
      in: header
externalDocs:
  description: Find out more about our development portal
  url: https://www.planradar.com/knowledge-base-overview/