Credentially Placement Roles API
Org-scoped roles a placement can reference (e.g. Band 6 RN).
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/credentially-placement-roles-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Credentially Public Compliance-packages Placement Roles API
description: Public API Proxy with Rate Limiting and Audit
version: 2.0.0
servers:
- url: https://app.credentially.io/gateway
description: Generated server url
tags:
- name: Placement Roles
description: Org-scoped roles a placement can reference (e.g. Band 6 RN).
paths:
/api/placement-roles/{id}:
get:
tags:
- Placement Roles
summary: Get a placement role by public id
description: '
**Rate Limit:** `delete-placement-role` (25 req / 1s)'
operationId: get_1
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: X-API-Version
in: header
schema:
type: string
default: 2.0.0
enum:
- 2.0.0
responses:
'200':
description: Role found
content:
'*/*':
schema:
$ref: '#/components/schemas/RoleResponse'
'403':
description: Token lacks scope, or role not in caller's organisation
'429':
description: Too many requests - the rate limit for this endpoint has been exceeded. Use the Retry-After header to determine when to retry.
headers:
Retry-After:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
format: int32
example: 1
security:
- bearer-key: []
put:
tags:
- Placement Roles
summary: Update a placement role
description: '
**Rate Limit:** `delete-placement-role` (25 req / 1s)'
operationId: update_2
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: X-API-Version
in: header
schema:
type: string
default: 2.0.0
enum:
- 2.0.0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleRequest'
required: true
responses:
'200':
description: Role updated
content:
'*/*':
schema:
$ref: '#/components/schemas/RoleResponse'
'400':
description: Validation failed
'403':
description: Token lacks scope, or role not in caller's organisation
'409':
description: A role with the new name already exists
'429':
description: Too many requests - the rate limit for this endpoint has been exceeded. Use the Retry-After header to determine when to retry.
headers:
Retry-After:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
format: int32
example: 1
security:
- bearer-key: []
delete:
tags:
- Placement Roles
summary: Delete a placement role
description: '
**Rate Limit:** `delete-placement-role` (25 req / 1s)'
operationId: delete_1
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
- name: X-API-Version
in: header
schema:
type: string
default: 2.0.0
enum:
- 2.0.0
responses:
'204':
description: Role deleted
'403':
description: Token lacks scope, or role not in caller's organisation
'429':
description: Too many requests - the rate limit for this endpoint has been exceeded. Use the Retry-After header to determine when to retry.
headers:
Retry-After:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
format: int32
example: 1
security:
- bearer-key: []
/api/placement-roles:
get:
tags:
- Placement Roles
summary: List placement roles
description: '
**Rate Limit:** `create-placement-role` (25 req / 1s)'
operationId: list_1
parameters:
- name: X-API-Version
in: header
schema:
type: string
default: 2.0.0
enum:
- 2.0.0
responses:
'200':
description: Roles retrieved
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/RoleResponse'
'401':
description: Missing or invalid bearer token
'403':
description: Token lacks required scope
'429':
description: Too many requests - the rate limit for this endpoint has been exceeded. Use the Retry-After header to determine when to retry.
headers:
Retry-After:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
format: int32
example: 1
security:
- bearer-key: []
post:
tags:
- Placement Roles
summary: Create a placement role
description: '
**Rate Limit:** `create-placement-role` (25 req / 1s)'
operationId: create_1
parameters:
- name: X-API-Version
in: header
schema:
type: string
default: 2.0.0
enum:
- 2.0.0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleRequest'
required: true
responses:
'201':
description: Role created
content:
'*/*':
schema:
$ref: '#/components/schemas/RoleResponse'
'400':
description: Validation failed
'409':
description: A role with that name already exists
'429':
description: Too many requests - the rate limit for this endpoint has been exceeded. Use the Retry-After header to determine when to retry.
headers:
Retry-After:
description: Number of seconds to wait before retrying the request.
schema:
type: integer
format: int32
example: 1
security:
- bearer-key: []
components:
schemas:
RoleResponse:
type: object
properties:
publicId:
type: string
format: uuid
name:
type: string
description:
type: string
createdAt:
type: string
format: date-time
createdBy:
type: string
format: uuid
updatedAt:
type: string
format: date-time
updatedBy:
type: string
format: uuid
RoleRequest:
type: object
properties:
name:
type: string
maxLength: 128
minLength: 0
description:
type: string
maxLength: 256
minLength: 0
required:
- name
securitySchemes:
bearer-key:
type: http
scheme: bearer
bearerFormat: JWT