Members and roles
Members and roles in the management API. 10 endpoints.
Read the guideOpenAPI 3.1 document
Try it settings
https://api.bifrostorbit.com/cms/manage/v1
The management API takes a management token, which is secret and acts as a person, so nothing here is sent from the docs.
Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.
Everyone in the organisation and its spaces
GET/organisations/{organisationId}/membersKey required
Everyone in the organisation and its spaces. Permission: member:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
Responses
200OKList of members.dataMember[]Fields of data
membershipIdstringAn id.
userIdstringAn id.
emailstringnamestringrolestringThe role's key.
roleNamestringspaceIdstring or nullnull for the whole organisation.
spaceNamestring or null
One of active, suspended, invited.statusstringcreatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks member:read.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/members' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": [ { "membershipId": "6650f1c2a9e4b1d2c3f40a31", "userId": "6650f1c2a9e4b1d2c3f40a30", "email": "ingrid.berg@northwilds.com", "name": "Ingrid Berg", "role": "editor", "roleName": "Editor", "spaceId": null, "spaceName": null, "status": "active", "createdAt": "2026-11-02T09:30:00.000Z" } ]}Invites a person, or gives them a role in a space
POST/organisations/{organisationId}/membersKey required
Invites a person, or gives them a role in a space. Permission: member:invite.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body
emailstringrequiredThe person's email address. New people get an invitation email.
rolestringrequiredA role key, ranked below your own.
Up to 64 characters.spaceIdstring or nulloptionalA space, for a role in that space only. Leave it out for the whole organisation.
Responses
201CreatedThe member.dataMemberFields of data
membershipIdstringAn id.
userIdstringAn id.
emailstringnamestringrolestringThe role's key.
roleNamestringspaceIdstring or nullnull for the whole organisation.
spaceNamestring or null
One of active, suspended, invited.statusstringcreatedAtstring
400Bad requestThe body isn't valid JSON. Or the role is the owner's or ranks at or above yours, or the email's domain is not allowed in the organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks member:invite, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
409ConflictThe person already has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/members' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"email":"ingrid.berg@northwilds.com","role":"editor"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "membershipId": "6650f1c2a9e4b1d2c3f40a31", "userId": "6650f1c2a9e4b1d2c3f40a30", "email": "ingrid.berg@northwilds.com", "name": "Ingrid Berg", "role": "editor", "roleName": "Editor", "spaceId": null, "spaceName": null, "status": "active", "createdAt": "2026-11-02T09:30:00.000Z" }}Removes access
DELETE/organisations/{organisationId}/members/{membershipId}Key required
Removes access. Removing someone from the organisation removes them from its spaces too. Permission: member:remove.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
membershipIdstringpath, requiredThe membership's id.
Responses
204No contentDone, nothing to return.400Bad requestYour own access, the owner, or a person ranked at or above you.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks member:remove, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such membership, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/members/6650f1c2a9e4b1d2c3f40a30' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Changes a role or region limits
PATCH/organisations/{organisationId}/members/{membershipId}Key required
Changes a role or region limits. Permission: member:update.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
membershipIdstringpath, requiredThe membership's id.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body, optional
rolestringoptionalA role key, ranked below your own.
regionKeysstring[] or nulloptionalRegion keys the person may change, or null for every region.
Responses
204No contentDone, nothing to return.400Bad requestThe body isn't valid JSON. Or your own access, the owner, or a role change your rank doesn't allow.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks member:update, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such membership, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
422Unprocessablerole isn't a role key.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/members/6650f1c2a9e4b1d2c3f40a30' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"role":"publisher","regionKeys":["norway"]}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Built-in and custom roles with their permissions
GET/organisations/{organisationId}/rolesKey required
Built-in and custom roles with their permissions. Permission: role:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
Responses
200OK[{ id, key, name, description, permissions, isSystem, rank }].dataRole[]Fields of data
idstringAn id.
keystringSuch as editor.
namestringdescriptionstring or nullpermissionsstring[]Such as content:publish.
isSystembooleanA built-in role.
rankinteger0 to 100. You can only manage roles ranked below your own.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks role:read.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/roles' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": [ { "id": "6650f1c2a9e4b1d2c3f40a44", "key": "editor", "name": "Editor", "description": "Writes and changes content.", "permissions": [ "content:read", "content:update" ], "isSystem": true, "rank": 1 } ]}Adds a custom role
POST/organisations/{organisationId}/rolesKey required
Adds a custom role. Permission: role:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body
keystringrequiredLowercase letters, digits, _ or -, starting with a letter.
Up to 64 characters.
Up to 200 characters.namestringrequired
Up to 500 characters.descriptionstring or nulloptionalpermissionsstring[]requiredAt least one, and only permissions you hold.
rankintegeroptional0 to 100, at most your own.
Default 10. At least 0. At most 100.
Responses
201CreatedThe role.dataRoleFields of data
idstringAn id.
keystringSuch as editor.
namestringdescriptionstring or nullpermissionsstring[]Such as content:publish.
isSystembooleanA built-in role.
rankinteger0 to 100. You can only manage roles ranked below your own.
400Bad requestThe body isn't valid JSON. Or a permission you don't hold or that doesn't exist, or a rank above your own.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks role:manage, or the plan has no custom roles.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such organisation, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
409ConflictA role with the key exists.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/roles' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"key":"trip-writer","name":"Trip writer","description":"Writes and updates trip pages.","permissions":["content:read","content:create","content:update"],"rank":20}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a44", "key": "editor", "name": "Editor", "description": "Writes and changes content.", "permissions": [ "content:read", "content:update" ], "isSystem": true, "rank": 1 }}Deletes a custom role nobody has
DELETE/organisations/{organisationId}/roles/{roleKey}Key required
Deletes a custom role nobody has. Permission: role:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
roleKeystringpath, requiredThe role's key, such as editor.
Responses
204No contentDone, nothing to return.400Bad requestA built-in role.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks role:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such role, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
409ConflictSomeone still has the role.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/roles/editor' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Changes a role
PATCH/organisations/{organisationId}/roles/{roleKey}Key required
Changes a role. Permission: role:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
roleKeystringpath, requiredThe role's key, such as editor.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body, optional
namestringoptionalBuilt-in roles keep their name.
Up to 200 characters.
Up to 500 characters.descriptionstring or nulloptionalpermissionsstring[]optionalrankintegeroptionalBuilt-in roles keep their rank.
At least 0. At most 100.
Responses
200OKThe role.dataRoleFields of data
idstringAn id.
keystringSuch as editor.
namestringdescriptionstring or nullpermissionsstring[]Such as content:publish.
isSystembooleanA built-in role.
rankinteger0 to 100. You can only manage roles ranked below your own.
400Bad requestThe body isn't valid JSON. Or a permission you don't hold, a built-in role's name or rank, or a role ranked at or above yours.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks role:manage, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such role, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/roles/editor' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"permissions":["content:read","content:create","content:update","content:publish"]}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "id": "6650f1c2a9e4b1d2c3f40a44", "key": "editor", "name": "Editor", "description": "Writes and changes content.", "permissions": [ "content:read", "content:update" ], "isSystem": true, "rank": 1 }}Who can open a space, including organisation members whose role sees every space
GET/organisations/{organisationId}/spaces/{spaceId}/accessKey required
Who can open a space, including organisation members whose role sees every space. Permission: member:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Responses
200OKList of members.dataSpaceMember[]Fields of data
membershipIdstringAn id.
userIdstringAn id.
emailstringnamestringrolestringroleNamestringspaceIdstring or nullAn id.
spaceNamestring or null
One of active, suspended, invited.statusstringcreatedAtstringviaOrganisationbooleanReaches the space through an organisation role that sees every space.
regionKeysstring[] or nullThe regions the person may change, or null for all.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks member:read.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such space, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/access' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": [ { "membershipId": "6650f1c2a9e4b1d2c3f40a31", "userId": "6650f1c2a9e4b1d2c3f40a30", "email": "ingrid.berg@northwilds.com", "name": "Ingrid Berg", "role": "editor", "roleName": "Editor", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "spaceName": "Northwilds website", "status": "active", "createdAt": "2026-11-02T09:30:00.000Z", "viaOrganisation": false, "regionKeys": [ "…" ] } ]}Invites a person to one space
POST/organisations/{organisationId}/spaces/{spaceId}/accessKey required
Invites a person to one space. Permission: member:invite.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.
Up to 255 characters.
Request body
emailstringrequired
Up to 64 characters.rolestringrequiredspaceIdstring or nulloptionalIgnored: the space in the address is used.
Responses
201CreatedThe member.dataMemberFields of data
membershipIdstringAn id.
userIdstringAn id.
emailstringnamestringrolestringThe role's key.
roleNamestringspaceIdstring or nullnull for the whole organisation.
spaceNamestring or null
One of active, suspended, invited.statusstringcreatedAtstring
400Bad requestThe body isn't valid JSON. Or the role is the owner's or ranks at or above yours, or the email's domain is not allowed.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
403ForbiddenLacks member:invite, or the token is read only.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
404Not foundNo such space, or it's in another organisation.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
409ConflictThe person already has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
500Server errorSomething went wrong on our side. Try again in a moment.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/access' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"email":"ingrid.berg@northwilds.com","role":"editor"}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "membershipId": "6650f1c2a9e4b1d2c3f40a31", "userId": "6650f1c2a9e4b1d2c3f40a30", "email": "ingrid.berg@northwilds.com", "name": "Ingrid Berg", "role": "editor", "roleName": "Editor", "spaceId": null, "spaceName": null, "status": "active", "createdAt": "2026-11-02T09:30:00.000Z" }}SchemasThe shapes the endpoints above answer with and take.
Error
Every error has this shape. Write code against code and the status, never the message.
errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.
Role
idstringAn id.
keystringSuch as editor.
namestringdescriptionstring or nullpermissionsstring[]Such as content:publish.
isSystembooleanA built-in role.
rankinteger0 to 100. You can only manage roles ranked below your own.
Member
membershipIdstringAn id.
userIdstringAn id.
emailstringnamestringrolestringThe role's key.
roleNamestringspaceIdstring or nullnull for the whole organisation.
spaceNamestring or null
One of active, suspended, invited.statusstringcreatedAtstring
SpaceMember
membershipIdstringAn id.
userIdstringAn id.
emailstringnamestringrolestringroleNamestringspaceIdstring or nullAn id.
spaceNamestring or null
One of active, suspended, invited.statusstringcreatedAtstringviaOrganisationbooleanReaches the space through an organisation role that sees every space.
regionKeysstring[] or nullThe regions the person may change, or null for all.