Skip to content
/Organization Members

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

/v1/organizations/current/members

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/members?page=1&size=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(MemberResponse)required
items[].​organizationUuidstring(uuid)required
items[].​accountUuidstring(uuid)required
items[].​roleUuidstring(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[].​removedAtstring or null(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
items[].​statusstringrequired
Enum"active""inactive""removed"
items[].​isOwnerbooleanrequired
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/members

Request

Security
Bearer
Bodyapplication/jsonrequired
accountUuidstring(uuid)required
roleUuidstring(uuid)required
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/organizations/current/members \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
    "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b"
  }'

Responses

Created

Bodyapplication/json
organizationUuidstring(uuid)required
accountUuidstring(uuid)required
roleUuidstring(uuid)required
createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired
Enum"active""inactive""removed"
isOwnerbooleanrequired
Response
application/json
{
  "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03",
  "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
  "createdAt": "2025-11-23T14:15:22.123456Z",
  "updatedAt": "2025-11-23T14:15:22.123456Z",
  "removedAt": "2025-11-23T14:15:22.123456Z",
  "status": "active",
  "isOwner": true
}

/v1/organizations/current/members/{accountUuid}

Request

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

Responses

OK

Bodyapplication/json
organizationUuidstring(uuid)required
accountUuidstring(uuid)required
roleUuidstring(uuid)required
createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired
Enum"active""inactive""removed"
isOwnerbooleanrequired
Response
application/json
{
  "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03",
  "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
  "createdAt": "2025-11-23T14:15:22.123456Z",
  "updatedAt": "2025-11-23T14:15:22.123456Z",
  "removedAt": "2025-11-23T14:15:22.123456Z",
  "status": "active",
  "isOwner": true
}

/v1/organizations/current/members/{accountUuid}

Request

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

Responses

No Content

Response
No content

/v1/organizations/current/members/{accountUuid}/role

Request

Security
Bearer
Path
accountUuidstring(uuid)required
Bodyapplication/jsonrequired
organizationRoleUuidstring(uuid)required
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/members/{accountUuid}/role' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organizationRoleUuid": "43be884b-80d7-4f40-9706-da2b6d65cee6"
  }'

Responses

OK

Bodyapplication/json
organizationUuidstring(uuid)required
accountUuidstring(uuid)required
roleUuidstring(uuid)required
createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired
Enum"active""inactive""removed"
isOwnerbooleanrequired
Response
application/json
{
  "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03",
  "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
  "createdAt": "2025-11-23T14:15:22.123456Z",
  "updatedAt": "2025-11-23T14:15:22.123456Z",
  "removedAt": "2025-11-23T14:15:22.123456Z",
  "status": "active",
  "isOwner": true
}

/v1/organizations/current/members/{accountUuid}/actions/lifecycle

Request

Security
Bearer
Path
accountUuidstring(uuid)required
Bodyapplication/jsonrequired
transitionstringrequired
Enum"activate""deactivate""restore"
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/organizations/current/members/{accountUuid}/actions/lifecycle' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "activate"
  }'

Responses

OK

Bodyapplication/json
organizationUuidstring(uuid)required
accountUuidstring(uuid)required
roleUuidstring(uuid)required
createdAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)required
Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired
Enum"active""inactive""removed"
isOwnerbooleanrequired
Response
application/json
{
  "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03",
  "accountUuid": "0ef9c2ec-a65c-4311-aee8-decdbb35014b",
  "roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
  "createdAt": "2025-11-23T14:15:22.123456Z",
  "updatedAt": "2025-11-23T14:15:22.123456Z",
  "removedAt": "2025-11-23T14:15:22.123456Z",
  "status": "active",
  "isOwner": true
}

Organizations

Operations

Organization Roles

Operations

Categories

Operations

Attributes

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS