Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/planradar-users-v1-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.
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 Users V1 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: Users V1
description: Manage all users in your account
paths:
/api/v1/{customer_id}/users:
get:
summary: Returns all users of a customer
tags:
- Users V1
description: 'This API returns all users that were created by a specific customer.
Without any extra parameters it will return the first 100 users ordered by ascending ID. Extra parameters can be added to filter and sort the results.
Users Sorting:
Users can be sorted by their attributes like firstname, company etc. .
The sort is always ascending unless the field name is prefixed with a minus (U+002D HYPHEN-MINUS, "-") i.e. `-id` or `id`.
Example: `/users?sort=-company`'
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: last_sync_date
in: query
description: ' is a Unix Timestamp. If it is set, only users that were created after that timestamp will be returned'
schema:
type: string
- name: sort
in: query
schema:
type: string
- name: pagesize
in: query
description: sets the number of users that should be returned per page <br/>Maximum is 500, default is 100
schema:
type: string
- name: page
in: query
description: sets the number of pages for the returned users
schema:
type: string
- name: search
in: query
description: search keyword based on which users are filtered
schema:
type: string
responses:
'404':
description: Users Not Found
operationId: getApiV1ByCustomerIdUsers
x-operation-id-source: derived
post:
summary: Creates user
tags:
- Users V1
security:
- apiKey: []
description: 'This API is used for creating users. Note: The ''permissions'' object with ''defects: true'' is required for non-subcontractor and non-watcher users.
**Rate Limit:** 10 requests per minute.'
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
responses:
'404':
description: User Not Created
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
required:
- firstname
- lastname
- mail
- permissions
properties:
firstname:
type: string
example: Max
description: first name of the user (required)
lastname:
type: string
description: last name of the user (required)
mail:
type: string
example: example@gmail.com
description: email address of the user (required)
active:
type: boolean
example: true
description: sets whether or not user is active
city:
type: string
example: Vienna
description: city of the user
company:
type: string
example: PlanRadar
description: company of the user
password:
type: string
example: Kl8957$kgj32
description: password of the user
retype_password:
type: string
example: Kl8957$kgj32
description: password confirmation - has to be the same as password
position:
type: string
example: intern
description: position of the user
street:
type: string
example: Ring Street 5
description: street of the user
tel:
type: string
example: '+43679455652823'
description: telephone number of the user
zipcode:
type: string
example: '1020'
description: zipcode of the user
subcontractor:
type: boolean
example: false
description: sets whether or not the user is of type subcontractor
watcher:
type: boolean
example: true
description: sets whether or not the user is of type watcher
project_ids:
type: array
description: array of the ids of the projects that the user is part of
items:
type: string
example: mdaown
role_ids:
type: array
description: array of the ids of the user's roles in the projects that he is part of - the roles are set for each project in the same order as the projects are sorted in the project_ids array
items:
type: string
group_ids:
type: array
description: array that takes the ids of the groups that the user is part of
items:
type: string
example: lm
is_mobile_syncs:
type: array
description: sets whether or not the data of the projects that the user is part of are synced on mobile devices - each boolean in this array is set for each project in the same order as the projects are sorted in the project_ids array
items:
type: boolean
permissions:
type: object
description: sets the permissions of the user (required for non-subcontractor and non-watcher users)
properties:
accounts:
type: boolean
example: false
api_documentation_access:
type: boolean
example: false
categories:
type: boolean
example: false
defects:
type: boolean
example: true
description: defects are tickets (required - must be set to true)
groups:
type: boolean
example: false
limited_projects:
type: boolean
example: false
projects:
type: boolean
example: false
report_templates:
type: boolean
example: false
roles:
type: boolean
example: false
statistics:
type: boolean
example: false
sub_users:
type: boolean
example: false
user_metrics:
type: boolean
example: false
users:
type: boolean
example: false
typed-values:
type: object
description: sets the values of the typed-fields
operationId: postApiV1ByCustomerIdUsers
x-operation-id-source: derived
/api/v1/{customer_id}/users/{user_id}:
get:
summary: Returns a specific user of a customer
tags:
- Users V1
description: This API returns a specific user that was created by the logged in customer.
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: user_id
in: path
required: true
schema:
type: string
responses:
'404':
description: User Not Found
operationId: getApiV1ByCustomerIdUsersByUserId
x-operation-id-source: derived
delete:
summary: Deletes a specific user of a customer
tags:
- Users V1
description: This API is used for deleting a specific user that was created by the logged in customer.
security:
- apiKey: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: user_id
in: path
required: true
schema:
type: string
responses:
'404':
description: User Not Found
operationId: deleteApiV1ByCustomerIdUsersByUserId
x-operation-id-source: derived
put:
summary: Updates a specific user of a customer
tags:
- Users V1
description: This API is used for updating a specific user that was created by the logged in customer.
security:
- apiKey: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: user_id
in: path
required: true
schema:
type: integer
responses:
'404':
description: User Not Found
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
$ref: '#/components/schemas/User'
operationId: putApiV1ByCustomerIdUsersByUserId
x-operation-id-source: derived
/api/v1/{customer_id}/users/downgrade_user_to_subcontractor:
put:
summary: Downgrades user to subcontractor
tags:
- Users V1
description: This API is used for downgrading the type of a user to subcontractor.
security:
- apiKey: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: user_id
in: query
schema:
type: string
responses:
'404':
description: User Not Found
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
user_id:
type: string
description: id of the user that should be downgraded - is required
watcher:
type: boolean
example: false
description: ' the only allowed value in order to downgrade the user is false'
operationId: putApiV1ByCustomerIdUsersDowngradeUserToSubcontractor
x-operation-id-source: derived
/api/v1/{customer_id}/users/activate_user:
post:
summary: Activates deactivated user
tags:
- Users V1
description: This API is used for reactivating a specific deactivated user.
security:
- apiKey: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: user_id
in: query
schema:
type: string
responses:
'404':
description: Could Not Reactivate User
operationId: postApiV1ByCustomerIdUsersActivateUser
x-operation-id-source: derived
/api/v1/{customer_id}/users/export_users_xls:
get:
summary: Exports users as an Excel file
tags:
- Users V1
description: This API is used for exporting all users of the logged in customer as an Excel file.
security:
- apiKey: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
responses:
'404':
description: Export Failed
operationId: getApiV1ByCustomerIdUsersExportUsersXls
x-operation-id-source: derived
components:
schemas:
User:
type: object
properties:
active:
type: boolean
example: true
description: sets whether or not user is active
city:
type: string
example: Vienna
description: city of the user
company:
type: string
example: PlanRadar
description: company of the user
firstname:
type: string
example: Max
description: first name of the user
group_ids:
type: array
description: array that takes the ids of the groups that the user is part of
items:
type: string
example: lm
is_mobile_syncs:
type: array
description: sets whether or not the data of the projects that the user is part of are synced on mobile devices - each boolean in this array is set for each project in the same order as the projects are sorted in the project_ids array
items:
type: boolean
lastname:
type: string
description: last name of the user
mail:
type: string
example: example@gmail.com
description: email address of the user
password:
type: string
example: Kl8957$kgj32
description: password of the user
permissions:
type: object
description: sets the permissions of the user
properties:
accounts:
type: boolean
example: false
api_documentation_access:
type: boolean
example: false
categories:
type: boolean
example: false
defects:
type: boolean
example: true
description: defects are tickets
groups:
type: boolean
example: false
limited_projects:
type: boolean
example: false
projects:
type: boolean
example: false
report_templates:
type: boolean
example: false
roles:
type: boolean
example: false
statistics:
type: boolean
example: false
sub_users:
type: boolean
example: false
user_metrics:
type: boolean
example: false
users:
type: boolean
example: false
position:
type: string
example: intern
description: position of the user
project_ids:
type: array
description: array of the ids of the projects that the user is part of
items:
type: string
example: mdaown
retype_password:
type: string
example: Kl8957$kgj32
description: ' password confirmation - has to be the same as password'
role_ids:
type: array
description: array of the ids of the user's roles in the projects that he is part of - the roles are set for each project in the same order as the projects are sorted in the project_ids array
items:
example: ''
type: string
street:
type: string
example: Ring Street 5
description: ' street of the user'
tel:
type: string
example: '+43679455652823'
description: ' telephone number of the user'
typed-values:
type: object
description: sets the values of the typed-fields
subcontractor:
type: boolean
example: false
description: sets whether or not the user is of type subcontractor
watcher:
type: boolean
example: true
description: sets whether or not the user is of type watcher
zipcode:
type: string
example: '1020'
description: zipcode of the user
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/