Roles API

A role is the permission set a collaborator holds on a team. Subscriby seeds three on every new team, admin, manager and viewer, and a team can add its own: a support-agent who may read and answer conversations but touch nothing else, a finance role that reads payouts and analytics. Each collaborator holds exactly one role, assigned when they are invited and changed through the team members endpoints; groups layer extra permissions on top of it for several people at once.

A role's permissions is a flat array of the same ability strings a personal access token carries, so a role can be matched against a token without a second round-trip, and the ability catalog is the list to pick from. Changing a role changes what every holder may do from the next request; deleting one detaches its permissions and leaves its holders in the team with nothing beyond what their groups grant.

Roles are read across every team the caller owns or belongs to, and a role on any other team is a 404 RESOURCE_NOT_FOUND, never a 403, so existence never leaks. Every write announces itself as a role.* event.

Endpoints

GET/v1/rolesList roles POST/v1/rolesCreate a role GET/v1/roles/{role}Get a role PATCH/v1/roles/{role}Update a role DELETE/v1/roles/{role}Delete a role

List roles

GET

curl https://api.subscriby.net/v1/roles \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Every role across the teams the caller can see, with its permission codes. Visibility is the union of every team the caller owns or belongs to; a role from a team the caller cannot see answers 404 RESOURCE_NOT_FOUND rather than 403, so existence never leaks.

Requires ability

role:view-any

The token must hold this ability, or the call is refused with 403.

MCP tool

list_roles

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Query Parameters

page?integer

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

Range1 <= value

Default1

per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

Range1 <= value <= 100

Default25

sort_by?string

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"created_at"

sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

"asc"
"desc"

Responses

200OKapplication/json

Roles across every team the caller belongs to.

data*array<>

The items on this page.

links*

Links to the first, last, previous and next pages.

meta*

The paging counters for this page.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/roles"

{  "data": [    {      "id": "d05e1a83-7c46-4f29-b613-8ae407c9d251",      "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",      "code": "manager",      "name": "Manager",      "description": "Manage plans, resources, and subscribers",      "owner_user_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",      "permissions": [        "project:view"      ],      "created_at": "2026-05-18T10:05:00Z"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 1,    "total": 0  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: RoleResource[];  links: Links;  meta: Meta;}export interface RoleResource {  id: string;  team_id: string;  code: string;  name: string | null;  description: string | null;  owner_user_id: string | null;  permissions: unknown[];  created_at: string | null;}export interface Links {  first: string | null;  last: string | null;  prev: string | null;  next: string | null;}export interface Meta {  current_page: number;  from: number | null;  last_page: number;  links: Link[];  path: string | null;  per_page: number;  to: number | null;  total: number;}export interface Link {  url: string | null;  label: string;  active: boolean;}

Create a role

POST

curl -X POST https://api.subscriby.net/v1/roles \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{        "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",        "code": "support-agent",        "name": "Support Agent",        "description": "Answers tickets, cannot touch billing",        "permissions": ["support-conversation:view-any", "support-conversation:update"]      }'

Choose the code deliberately. code is the stable identifier permissions are addressed by. It must be unique within the team and cannot be changed afterwards: renaming one would detach every assignment that referenced it. Only name, description and the permission set are mutable.

permissions accepts codes from the permission catalog in entity:action form. An unknown code is refused rather than silently dropped, so a typo fails loudly instead of creating a role that grants less than you think. Omit the field for a role that grants nothing yet.

Answers 201 with the role and emits role.created.

Requires ability

role:create

The token must hold this ability, or the call is refused with 403.

Fires one event

role.created

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

create_role

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Header Parameters

Idempotency-Key*string

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Formatuuid

Request body

JSONWhat the request carriesRequiredapplication/json

A role's team, code, name, description and permissions. On create team_id, code and name are required; on update team_id and code are prohibited (a role is neither moved nor renamed by code) and every other field is optional.

team_id*string

The team to create the role in; the caller must belong to it, and a team outside their account answers 404. Prohibited on update: a role cannot be moved between teams.

Formatuuid

code*string

The stable identifier permissions are addressed by, up to 255 letters, numbers, dashes and underscores, unique within the team and immutable afterwards: renaming one would detach every assignment that referenced it. Prohibited on update.

Lengthlength <= 255

name*string

The display name, up to 255 characters.

Lengthlength <= 255

description?|

What the role is for, up to 255 characters; null clears it.

Lengthlength <= 255

permissions?array<>

The permission codes the role grants, in entity:action form. Sending it sets the role's permissions to exactly this list; omit the key to leave the existing set untouched. Omit it on create for a role that grants nothing yet.

Responses

201Createdapplication/json

The role resource as a 201.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

When team_id is not one of the caller's teams.

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when a role with that code already exists in the team (error.context.code names it), or a permission code is unknown.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/roles" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12" \  -H "Content-Type: application/json" \  -d '{    "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",    "code": "string",    "name": "string"  }'

{  "data": {    "id": "d05e1a83-7c46-4f29-b613-8ae407c9d251",    "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",    "code": "manager",    "name": "Manager",    "description": "Manage plans, resources, and subscribers",    "owner_user_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",    "permissions": [      "project:view"    ],    "created_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

Request

export interface StoreRoleRequest {  team_id: string;  code: string;  name: string;  description?: string | null;  permissions?: ("project:view-any" | "project:view" | "project:create" | "project:update" | "project:delete" | "project-payment-method:view-any" | "project-payment-method:view" | "project-payment-method:create" | "project-payment-method:update" | "project-payment-method:delete" | "project-resource:view-any" | "project-resource:view" | "project-resource:create" | "project-resource:update" | "project-resource:delete" | "project-access-code:view-any" | "project-access-code:view" | "project-access-code:create" | "project-access-code:update" | "project-access-code:delete" | "project-coupon:view-any" | "project-coupon:view" | "project-coupon:create" | "project-coupon:update" | "project-coupon:delete" | "project-subscription:view-any" | "project-subscription:view" | "project-subscription:create" | "project-subscription:update" | "project-subscription:delete" | "project-subscription-plan:view-any" | "project-subscription-plan:view" | "project-subscription-plan:create" | "project-subscription-plan:update" | "project-subscription-plan:delete" | "project-user:view-any" | "project-user:view" | "project-user:create" | "project-user:update" | "project-user:delete" | "project-recovery:view-any" | "project-recovery:view" | "project-recovery:create" | "project-recovery:update" | "project-recovery:delete" | "project-connector:view-any" | "project-connector:view" | "project-connector:create" | "project-connector:update" | "project-connector:delete" | "support-conversation:view-any" | "support-conversation:view" | "support-conversation:create" | "support-conversation:update" | "support-conversation:delete" | "team-member:view-any" | "team-member:view" | "team-member:invite" | "team-member:remove" | "team-member:update-role")[];}

Response

export interface Response {  data: RoleResource;}export interface RoleResource {  id: string;  team_id: string;  code: string;  name: string | null;  description: string | null;  owner_user_id: string | null;  permissions: unknown[];  created_at: string | null;}

Get a role

GET

One role with its permission codes. permissions is a flat array of the exact ability strings granted by this role, the same strings used as token abilities, so you can match roles against tokens without a second round-trip.

Requires ability

role:view

The token must hold this ability, or the call is refused with 403.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

role*string

The role, resolved by the route binder.

Formatuuid

Responses

200OKapplication/json

The role resource with its permissions.

data*

The response's payload.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/roles/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": {    "id": "d05e1a83-7c46-4f29-b613-8ae407c9d251",    "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",    "code": "manager",    "name": "Manager",    "description": "Manage plans, resources, and subscribers",    "owner_user_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",    "permissions": [      "project:view",      "project:update",      "project-user:view-any",      "project-user:update"    ],    "created_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: RoleResource;}export interface RoleResource {  id: string;  team_id: string;  code: string;  name: string | null;  description: string | null;  owner_user_id: string | null;  permissions: unknown[];  created_at: string | null;}

Update a role

PATCH

curl -X PATCH https://api.subscriby.net/v1/roles/$ROLE_ID \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{"name": "Senior Support Agent", "permissions": ["support-conversation:view-any"]}'

Permissions replace, they do not merge. Sending permissions sets the role's permissions to exactly that list; anything omitted is revoked. Omit the key entirely to leave the existing set untouched while changing only the name or description.

Answers 200 with the role and emits role.updated.

Requires ability

role:update

The token must hold this ability, or the call is refused with 403.

Fires one event

role.updated

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

update_role

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

role*string

The role, resolved by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Request body

JSONWhat the request carriesRequiredapplication/json

team_id*string

The team to create the role in; the caller must belong to it, and a team outside their account answers 404. Prohibited on update: a role cannot be moved between teams.

Formatuuid

code*string

Lengthlength <= 255

name*string

The display name, up to 255 characters.

Lengthlength <= 255

description?|

What the role is for, up to 255 characters; null clears it.

Lengthlength <= 255

permissions?array<>

Responses

200OKapplication/json

The updated role resource.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when code or team_id is sent (a role cannot be renamed at the code level or moved between teams), or a permission code is unknown.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X PATCH "https://example.com/v1/roles/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12" \  -H "Content-Type: application/json" \  -d '{    "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",    "code": "string",    "name": "string"  }'

{  "data": {    "id": "d05e1a83-7c46-4f29-b613-8ae407c9d251",    "team_id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",    "code": "manager",    "name": "Manager",    "description": "Manage plans, resources, and subscribers",    "owner_user_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",    "permissions": [      "project:view"    ],    "created_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

Request

export interface StoreRoleRequest {  team_id: string;  code: string;  name: string;  description?: string | null;  permissions?: ("project:view-any" | "project:view" | "project:create" | "project:update" | "project:delete" | "project-payment-method:view-any" | "project-payment-method:view" | "project-payment-method:create" | "project-payment-method:update" | "project-payment-method:delete" | "project-resource:view-any" | "project-resource:view" | "project-resource:create" | "project-resource:update" | "project-resource:delete" | "project-access-code:view-any" | "project-access-code:view" | "project-access-code:create" | "project-access-code:update" | "project-access-code:delete" | "project-coupon:view-any" | "project-coupon:view" | "project-coupon:create" | "project-coupon:update" | "project-coupon:delete" | "project-subscription:view-any" | "project-subscription:view" | "project-subscription:create" | "project-subscription:update" | "project-subscription:delete" | "project-subscription-plan:view-any" | "project-subscription-plan:view" | "project-subscription-plan:create" | "project-subscription-plan:update" | "project-subscription-plan:delete" | "project-user:view-any" | "project-user:view" | "project-user:create" | "project-user:update" | "project-user:delete" | "project-recovery:view-any" | "project-recovery:view" | "project-recovery:create" | "project-recovery:update" | "project-recovery:delete" | "project-connector:view-any" | "project-connector:view" | "project-connector:create" | "project-connector:update" | "project-connector:delete" | "support-conversation:view-any" | "support-conversation:view" | "support-conversation:create" | "support-conversation:update" | "support-conversation:delete" | "team-member:view-any" | "team-member:view" | "team-member:invite" | "team-member:remove" | "team-member:update-role")[];}

Response

export interface Response {  data: RoleResource;}export interface RoleResource {  id: string;  team_id: string;  code: string;  name: string | null;  description: string | null;  owner_user_id: string | null;  permissions: unknown[];  created_at: string | null;}

Delete a role

DELETE

curl -X DELETE https://api.subscriby.net/v1/roles/$ROLE_ID \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)"

Returns 204 No Content, and detaches the role's permissions on the way out. Anyone currently holding the role loses whatever it granted them; they stay in the team. Not gated by tier. Emits role.deleted.

Restricted to whoever created the role, unless the caller owns the team. Belonging to a team is not licence to dismantle how everyone else in it is permissioned.

Requires ability

role:delete

The token must hold this ability, or the call is refused with 403.

Fires one event

role.deleted

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

delete_role

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

role*string

The role, resolved by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Responses

204No content

No content

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

When the caller neither created the role nor owns the team; error.context.role_id names it.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X DELETE "https://example.com/v1/roles/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12"

No body on this response.

Teams APITeams group creators, roles, and projects.Team Members APITeam members are the humans who collaborate inside a team: the creator who owns it and the people they invited to help run its projects.Groups APINamed permission bundles several people share Ability CatalogEvery ability string a Subscriby token can carry, what enforces it, and how to pick the right ones when minting.role.* eventsRole create, update and delete.

Roles API

EndpointsCopy Anchor Link

List rolesCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Create a roleCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ResponsesCopy Anchor Link

Get a roleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Update a roleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ResponsesCopy Anchor Link

Delete a roleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Related

On this page

Endpoints

List roles

Authorization

Query Parameters

Responses

Create a role

Authorization

Header Parameters

Request body

Responses

Get a role

Authorization

Path Parameters

Responses

Update a role

Authorization

Path Parameters

Header Parameters

Request body

Responses

Delete a role

Authorization

Path Parameters

Header Parameters

Responses