find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/planradar:planradar-roles-v2-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: PlanRadar's API Documentation 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.
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
      operationId: getApiV2ByCustomerIdRoles
      x-operation-id-source: derived
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/