Skip to content
API Reference
/
/
/v1/organizations/current...

Apiera REST API (1.0.0)

The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.apiera.io/_mock/openapi/
http://localhost:5281/

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Sku Weights

Operations

Family Attributes

Operations

Family Categories

Operations

Families

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

/v1/organizations/current/roles

Request

Security
Bearer
Query
pageinteger(int32)
Default 1
sizeinteger(int32)
Default 20
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/roles?page=1&size=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(RoleResponse)required
items[].​uuidstring(uuid)required
items[].​organizationUuidstring(uuid)required
items[].​createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
items[].​updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
items[].​namestringrequired
items[].​descriptionstring or nullrequired
paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
{
  "items": [
    { … }
  ],
  "pagination": {
    "page": 0,
    "size": 0,
    "totalItems": 0,
    "totalPages": 0
  }
}

/v1/organizations/current/roles

Request

Security
Bearer
Bodyapplication/jsonrequired
namestringrequired
descriptionstring or nullrequired
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/organizations/current/roles \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string"
  }'

Responses

Created

Bodyapplication/json
uuidstring(uuid)required
organizationUuidstring(uuid)required
createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
namestringrequired
descriptionstring or nullrequired
Response
application/json
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03",
  "createdAt": "2025-11-23T14:15:22.123456Z",
  "updatedAt": "2025-11-23T14:15:22.123456Z",
  "name": "string",
  "description": "string"
}

/v1/organizations/current/roles/{organizationRoleUuid}

Request

Security
Bearer
Path
organizationRoleUuidstring(uuid)required
curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/roles/{organizationRoleUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
uuidstring(uuid)required
organizationUuidstring(uuid)required
createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
namestringrequired
descriptionstring or nullrequired
Response
application/json
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03",
  "createdAt": "2025-11-23T14:15:22.123456Z",
  "updatedAt": "2025-11-23T14:15:22.123456Z",
  "name": "string",
  "description": "string"
}

/v1/organizations/current/roles/{organizationRoleUuid}

Request

Security
Bearer
Path
organizationRoleUuidstring(uuid)required
Bodyapplication/jsonrequired
namestringrequired
descriptionstring or nullrequired
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/roles/{organizationRoleUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string"
  }'

Responses

OK

Bodyapplication/json
uuidstring(uuid)required
organizationUuidstring(uuid)required
createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
namestringrequired
descriptionstring or nullrequired
Response
application/json
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03",
  "createdAt": "2025-11-23T14:15:22.123456Z",
  "updatedAt": "2025-11-23T14:15:22.123456Z",
  "name": "string",
  "description": "string"
}

/v1/organizations/current/roles/{organizationRoleUuid}

Request

Security
Bearer
Path
organizationRoleUuidstring(uuid)required
curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/roles/{organizationRoleUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

/v1/organizations/current/roles/{organizationRoleUuid}/permissions/{permissionUuid}

Request

Security
Bearer
Path
organizationRoleUuidstring(uuid)required
permissionUuidstring(uuid)required
curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/roles/{organizationRoleUuid}/permissions/{permissionUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

/v1/organizations/current/roles/{organizationRoleUuid}/permissions/{permissionUuid}

Request

Security
Bearer
Path
organizationRoleUuidstring(uuid)required
permissionUuidstring(uuid)required
curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/roles/{organizationRoleUuid}/permissions/{permissionUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

No Content

Response
No content

Categories

Operations

Attributes

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS