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-roles-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 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
  description: Get the roles that you have defined in your account
paths:
  /api/v1/{customer_id}/roles:
    get:
      summary: Returns all roles
      tags:
      - Roles
      description: 'This API returns all roles that were created by the logged in customer. Without any extra parameters it will return the first 100 roles ordered by ascending ID. Extra parameters can be added to sort the results.

        Role Sorting Roles can be sorted by their attributes like id, name, creation date: created-on and whether a role is an admin role: is-admin-role. The sort is always ascending unless the field name is prefixed with a minus (U+002D HYPHEN-MINUS, "-") i.e. `-id` or `id`

        Example#1: `/roles?sort=-id`

        Example#2: `/roles?sort=created-on`'
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: sets the number of pages for the returned roles
        schema:
          type: integer
      - name: pagesize
        in: query
        description: sets the number of roles that should be returned per page <br> Maximum is 500, default is 100
        schema:
          type: integer
      - name: last_sync_date
        in: query
        description: is a Unix Timestamp. If it is set, only roles that were created after that timestamp will be returned
        schema:
          type: string
      - name: search
        in: query
        description: ' keyword, based on which the roles will be filtered'
        schema:
          type: string
      - name: sort
        in: query
        schema:
          type: string
      responses:
        '404':
          description: Not Found
      operationId: getApiV1ByCustomerIdRoles
      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/