Flagsmith

flagsmith Organisations API

Manage organisations within Flagsmith. Organisations are the top-level container for projects, users, and billing.

GitHub OpenAPI

Operations 106

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /organisations/ List the organisations I belong to · List organisations #
Ask an LLM
“Which Flagsmith organisations does my account have access to?”
“Can I see every organisation I'm in along with its subscription and usage?”
Tell an agent
List all the organisations I have access to.
Show my organisations with their subscription details.
GET /organisations/{organisation_id}/ Get an organisation's plan and usage limits · Get an organisation #
Ask an LLM
“What subscription plan and feature usage limits does my organisation have?”
“Can I check an organisation's name and plan limits by its organisation_id?”
Tell an agent
Get the plan and usage limits for organisation {organisation_id}.
Show the subscription plan of organisation {organisation_id}.
POST /api/v1/organisations/ Create a new organisation · Api v1 organisations create #
Ask an LLM
“How do I create a brand-new organisation under my account?”
“Can I require two-factor auth for everyone when I set up a new organisation?”
Tell an agent
Create an organisation named {name}.
Create organisation {name} with webhook notifications sent to {webhook_notification_email}.
PUT /api/v1/organisations/{organisation_id}/licence Upload or replace an organisation's licence · Api v1 organisations licence update #
Ask an LLM
“Where do I apply a self-hosted licence to my organisation?”
“Can I replace the licence attached to an organisation?”
Tell an agent
Update the licence for organisation {organisation_id}.
Apply a new licence file to organisation {organisation_id}.
GET /api/v1/organisations/{organisation_pk}/api-usage-notification/ List API usage notifications for an organisation · Api v1 organisations api usage notification list #
Ask an LLM
“Has my organisation been warned about approaching its API request limit?”
“What API usage alerts has an organisation received?”
Tell an agent
List API usage notifications for organisation {organisation_pk}.
Show page {page} of organisation {organisation_pk}'s API usage alerts.
POST /api/v1/organisations/{organisation_pk}/github/create-cleanup-issue/ Open a GitHub issue to clean up stale flags · Api v1 organisations github create cleanup issue create #
Ask an LLM
“Can Flagsmith open a GitHub issue reminding us to remove an old flag from code?”
“Is there a way to create a flag cleanup issue in our linked GitHub repo?”
Tell an agent
Create a GitHub cleanup issue for organisation {organisation_pk}.
Raise a flag-removal cleanup issue in GitHub from organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/github/issues/ List GitHub issues from the linked integration · Api v1 organisations github issues retrieve #
Ask an LLM
“Which GitHub issues can I link to a feature flag?”
“Can I browse issues from the GitHub repos connected to my organisation?”
Tell an agent
List GitHub issues available to organisation {organisation_pk}.
Show the GitHub issues I could attach to a flag in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/github/pulls/ List GitHub pull requests from the integration · Api v1 organisations github pulls retrieve #
Ask an LLM
“What pull requests from our GitHub repos can be linked to a flag?”
“Can I see open PRs through the organisation's GitHub integration?”
Tell an agent
List GitHub pull requests for organisation {organisation_pk}.
Show the PRs visible through organisation {organisation_pk}'s GitHub connection.
GET /api/v1/organisations/{organisation_pk}/github/repo-contributors/ List contributors to a linked GitHub repo · Api v1 organisations github repo contributors retrieve #
Ask an LLM
“Who contributes to the GitHub repository we linked to Flagsmith?”
“Can I pull the contributor list of a connected repo?”
Tell an agent
List repo contributors from organisation {organisation_pk}'s GitHub integration.
Show who contributes to the linked GitHub repo for organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/github/repositories/ List GitHub repositories the integration can reach · Api v1 organisations github repositories retrieve #
Ask an LLM
“Which GitHub repositories has my organisation's integration been granted?”
“Can I see the repos available to connect to projects?”
Tell an agent
List GitHub repositories for organisation {organisation_pk}.
Show the repos the GitHub app can access for organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/groups/ Create a user group in an organisation · Api v1 organisations groups create #
Ask an LLM
“How do I create a permission group for my team?”
“Can I make a group that new users join by default?”
Tell an agent
Create group {name} in organisation {organisation_pk}.
Create group {name} in organisation {organisation_pk} with users {users}.
GET /api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/ List roles assigned to a group · Api v1 organisations groups roles list #
Ask an LLM
“Which roles has a user group been given?”
“What roles does this group inherit permissions from?”
Tell an agent
List roles for group {group_pk} in organisation {organisation_pk}.
Show the roles attached to group {group_pk} of organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/{id}/ Remove a role from a group · Api v1 organisations groups roles destroy #
Ask an LLM
“Can I take a role away from a group without deleting the role?”
“How would I stop a group from inheriting a role's permissions?”
Tell an agent destructive · confirm first
Remove role {id} from group {group_pk} in organisation {organisation_pk}.
Unassign role {id} from group {group_pk} of organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/groups/{id}/ Get a user group's details · Api v1 organisations groups retrieve #
Ask an LLM
“Who is in a particular group and is it a default group?”
“Can I view one group's full details including its members?”
Tell an agent
Show group {id} in organisation {organisation_pk}.
Get the members of group {id} in organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/groups/{id}/ Replace a group's settings and members · Api v1 organisations groups update #
Ask an LLM
“Can I overwrite a group's name and full member list in one request?”
“What call replaces every field on an existing group?”
Tell an agent
Replace group {id} in organisation {organisation_pk} with name {name} and users {users}.
Fully update group {id} of organisation {organisation_pk}, renaming it {name}.
PATCH /api/v1/organisations/{organisation_pk}/groups/{id}/ Change some settings on a group · Api v1 organisations groups partial update #
Ask an LLM
“Can I just rename a group without touching its members?”
“Is it possible to flip a group to be the default group for new users?”
Tell an agent
Rename group {id} in organisation {organisation_pk} to {name}.
Set is_default to {is_default} on group {id} of organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/groups/{id}/ Delete a user group · Api v1 organisations groups destroy #
Ask an LLM
“How do I delete a group we no longer use?”
“Does deleting a group remove the users from the organisation too?”
Tell an agent destructive · confirm first
Delete group {id} from organisation {organisation_pk}.
Remove the {id} group entirely from organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/groups/{id}/add-users/ Add users to a group · Api v1 organisations groups add users create #
Ask an LLM
“How do I add several people to an existing group at once?”
“Can I put new teammates into a group by their user IDs?”
Tell an agent
Add users {user_ids} to group {id} in organisation {organisation_pk}.
Put user {user_ids} into group {id} of organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/groups/{id}/remove-users/ Remove users from a group · Api v1 organisations groups remove users create #
Ask an LLM
“Can I take a few people out of a group but keep them in the organisation?”
“What's the call to drop users from a group by ID?”
Tell an agent
Remove users {user_ids} from group {id} in organisation {organisation_pk}.
Take user {user_ids} out of group {id} of organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/groups/my-groups/ List the groups I'm a member of · Api v1 organisations groups my groups retrieve #
Ask an LLM
“Which groups am I personally a member of in this organisation?”
“Can I get a summary of just my own groups?”
Tell an agent
List my groups in organisation {organisation_pk}.
Show summaries of the groups I belong to in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/groups/summaries/ List summaries of every group in an organisation · Api v1 organisations groups summaries retrieve #
Ask an LLM
“What groups exist across the whole organisation?”
“Can I get a lightweight summary of all groups rather than full details?”
Tell an agent
List summaries of all groups in organisation {organisation_pk}.
Give me every group name in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/invites/{id}/ Get a pending email invite · Api v1 organisations invites retrieve #
Ask an LLM
“Who sent a particular email invite and when?”
“Can I check the details of one pending invitation?”
Tell an agent
Show invite {id} in organisation {organisation_pk}.
Get the email and groups on pending invite {id} for organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/invites/{id}/ Cancel a pending email invite · Api v1 organisations invites destroy #
Ask an LLM
“Can I withdraw an email invitation someone hasn't accepted yet?”
“What's the way to cancel an invite sent to the wrong address?”
Tell an agent destructive · confirm first
Cancel invite {id} in organisation {organisation_pk}.
Delete the pending email invite {id} from organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/invites/{id}/resend/ Resend an email invite · Api v1 organisations invites resend create #
Ask an LLM
“Can I resend an invitation email to someone who lost it?”
“What if an invitee never got the original invite email?”
Tell an agent
Resend invite {id} in organisation {organisation_pk} to {email}.
Send invite {id} again to {email} on behalf of {invited_by} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/master-api-keys/ List an organisation's admin API keys · Api v1 organisations master api keys list #
Ask an LLM
“Which organisation-level admin API keys exist and which are revoked?”
“Can I audit every master API key our organisation has issued?”
Tell an agent
List admin API keys for organisation {organisation_pk}.
Show page {page} of organisation {organisation_pk}'s master API keys.
POST /api/v1/organisations/{organisation_pk}/master-api-keys/ Create an organisation admin API key · Api v1 organisations master api keys create #
Ask an LLM
“How do I create an API key to automate the Flagsmith admin API?”
“Can I give a new master API key an expiry date and non-admin rights?”
Tell an agent
Create a master API key named {name} for organisation {organisation_pk}.
Create admin key {name} in organisation {organisation_pk} expiring on {expiry_date}.
GET /api/v1/organisations/{organisation_pk}/master-api-keys/{api_key_prefix}/roles/ List roles attached to an admin API key · Api v1 organisations master api keys roles list #
Ask an LLM
“What roles govern what a particular master API key can do?”
“Which roles are assigned to the key with a given prefix?”
Tell an agent
List roles for master API key {api_key_prefix} in organisation {organisation_pk}.
Show the roles on admin key {api_key_prefix} of organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/master-api-keys/{api_key_prefix}/roles/{id}/detach-roles-from-master-api-key/ Detach a role from an admin API key · Api v1 organisations master api keys roles detach roles from master api key… #
Ask an LLM
“Can I strip a role off a master API key without revoking the key?”
“How would I narrow an admin key's access by detaching one role?”
Tell an agent destructive · confirm first
Detach role {id} from master API key {api_key_prefix} in organisation {organisation_pk}.
Remove role {id} from admin key {api_key_prefix} of organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/ Get an admin API key by prefix · Api v1 organisations master api keys retrieve #
Ask an LLM
“Is a given master API key still valid or has it expired?”
“Who created the admin key with this prefix?”
Tell an agent
Show master API key {prefix} in organisation {organisation_pk}.
Check whether admin key {prefix} of organisation {organisation_pk} has expired.
PUT /api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/ Replace an admin API key's settings · Api v1 organisations master api keys update #
Ask an LLM
“Can I overwrite all the settings of a master API key in one call?”
“What request fully replaces an admin key's name, expiry and admin flag?”
Tell an agent
Fully update master API key {prefix} in organisation {organisation_pk} with name {name}.
Replace admin key {prefix} of organisation {organisation_pk}, setting expiry {expiry_date} and is_admin {is_admin}.
PATCH /api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/ Revoke or tweak an admin API key · Api v1 organisations master api keys partial update #
Ask an LLM
“Can I mark a master API key as revoked without deleting it?”
“Is there a way to change just the expiry date on an admin key?”
Tell an agent
Set revoked to {revoked} on master API key {prefix} in organisation {organisation_pk}.
Change only the expiry of admin key {prefix} in organisation {organisation_pk} to {expiry_date}.
DELETE /api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/ Delete an admin API key · Api v1 organisations master api keys destroy #
Ask an LLM
“How do I delete a leaked organisation API key?”
“Will deleting a master API key break automations that use it?”
Tell an agent destructive · confirm first
Delete master API key {prefix} from organisation {organisation_pk}.
Permanently remove admin key {prefix} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/metadata-model-fields/ List metadata fields applied to models · Api v1 organisations metadata model fields list #
Ask an LLM
“Which custom metadata fields are attached to features, segments or environments?”
“What metadata is required for which object types in my organisation?”
Tell an agent
List metadata model fields for organisation {organisation_pk}.
Show page {page} of organisation {organisation_pk}'s metadata field assignments.
POST /api/v1/organisations/{organisation_pk}/metadata-model-fields/ Attach a metadata field to an object type · Api v1 organisations metadata model fields create #
Ask an LLM
“How do I make a custom metadata field appear on features or segments?”
“Can I require a metadata field whenever a certain object type is created?”
Tell an agent
Attach metadata field {field} to content type {content_type} in organisation {organisation_pk}.
Make field {field} on {content_type} required for {is_required_for} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/metadata-model-fields/{id}/ Get one metadata field assignment · Api v1 organisations metadata model fields retrieve #
Ask an LLM
“What object type is a given metadata field assignment bound to?”
“Can I see whether one metadata model field is required?”
Tell an agent
Show metadata model field {id} in organisation {organisation_pk}.
Get the requirement settings for metadata assignment {id} of organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/metadata-model-fields/{id}/ Replace a metadata field assignment · Api v1 organisations metadata model fields update #
Ask an LLM
“Can I fully redefine which field and object type a metadata assignment uses?”
“What call replaces a metadata model field in one go?”
Tell an agent
Replace metadata model field {id} in organisation {organisation_pk} with field {field} on {content_type}.
Fully update metadata assignment {id} of organisation {organisation_pk} to target {content_type}.
PATCH /api/v1/organisations/{organisation_pk}/metadata-model-fields/{id}/ Change which models require a metadata field · Api v1 organisations metadata model fields partial update #
Ask an LLM
“Can I just change where a metadata field is required without redefining it?”
“Is it possible to make an existing metadata field optional again?”
Tell an agent
Set is_required_for to {is_required_for} on metadata model field {id} in organisation {organisation_pk}.
Partially update metadata assignment {id} of organisation {organisation_pk} to field {field}.
DELETE /api/v1/organisations/{organisation_pk}/metadata-model-fields/{id}/ Detach a metadata field from an object type · Api v1 organisations metadata model fields destroy #
Ask an LLM
“How do I stop a metadata field from showing up on an object type?”
“Can I delete a metadata field assignment without deleting the field itself?”
Tell an agent destructive · confirm first
Delete metadata model field {id} from organisation {organisation_pk}.
Remove metadata assignment {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/metadata-model-fields/supported-content-types/ List object types that accept metadata · Api v1 organisations metadata model fields supported content types list #
Ask an LLM
“Which kinds of objects can I attach custom metadata to?”
“What content types does metadata support?”
Tell an agent
List content types that support metadata in organisation {organisation_pk}.
Show which object types can carry metadata for organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/metadata-model-fields/supported-required-for-models/ List models a metadata field can be required for · Api v1 organisations metadata model fields supported required for models list #
Ask an LLM
“For a given model, where can a metadata field be made mandatory?”
“Which 'required for' options exist for metadata on a model?”
Tell an agent
List supported required-for models for {model_name} in organisation {organisation_pk}.
Show where metadata can be required when attached to {model_name} in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/roles/ Create a role in an organisation · Api v1 organisations roles create #
Ask an LLM
“How do I define a reusable role for role-based access control?”
“Can I create a role with a description and tags?”
Tell an agent
Create role {name} in organisation {organisation_pk}.
Create role {name} described as {description} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{id}/ Get a role's details · Api v1 organisations roles retrieve #
Ask an LLM
“What is a specific role called and how is it described?”
“Can I look up one role in my organisation?”
Tell an agent
Show role {id} in organisation {organisation_pk}.
Get the name and tags of role {id} in organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/roles/{id}/ Replace a role's name, description and tags · Api v1 organisations roles update #
Ask an LLM
“Can I overwrite every field on a role at once?”
“Which call fully replaces a role definition?”
Tell an agent
Replace role {id} in organisation {organisation_pk} with name {name} and description {description}.
Fully update role {id} of organisation {organisation_pk} to name {name}.
PATCH /api/v1/organisations/{organisation_pk}/roles/{id}/ Rename a role or change its tags · Api v1 organisations roles partial update #
Ask an LLM
“Can I just rename a role and leave everything else alone?”
“Is it possible to update only a role's tags?”
Tell an agent
Rename role {id} in organisation {organisation_pk} to {name}.
Set tags {tags} on role {id} of organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/roles/{id}/ Delete a role · Api v1 organisations roles destroy #
Ask an LLM
“What happens to groups and keys that use a role if I delete it?”
“How do I get rid of a role we no longer need?”
Tell an agent destructive · confirm first
Delete role {id} from organisation {organisation_pk}.
Permanently remove role {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/environments-permissions/ List a role's permissions in an environment · Api v1 organisations roles environments permissions list #
Ask an LLM
“What can a role do inside a specific environment?”
“Which environment-level permissions has a role been granted?”
Tell an agent
List role {role_pk}'s permissions in environment {environment} for organisation {organisation_pk}.
Show environment {environment} permissions held by role {role_pk} in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/roles/{role_pk}/environments-permissions/ Grant a role permissions on an environment · Api v1 organisations roles environments permissions create #
Ask an LLM
“How do I give a role permission to change flags in one environment?”
“Can I make a role an admin of a particular environment?”
Tell an agent
Grant role {role_pk} permissions {permissions} on environment {environment} in organisation {organisation_pk}.
Make role {role_pk} an environment admin ({admin}) of {environment} with permissions {permissions} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/environments-permissions/{id}/ Get one environment permission grant for a role · Api v1 organisations roles environments permissions retrieve #
Ask an LLM
“Can I inspect a single environment permission record on a role?”
“What exactly does one of a role's environment grants allow?”
Tell an agent
Show environment permission {id} for role {role_pk} in organisation {organisation_pk}.
Get role {role_pk}'s environment grant {id} in organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/roles/{role_pk}/environments-permissions/{id}/ Replace a role's environment permission grant · Api v1 organisations roles environments permissions update #
Ask an LLM
“Can I overwrite the full permission list a role has on an environment?”
“Which call replaces an environment permission grant entirely?”
Tell an agent
Replace environment permission {id} on role {role_pk} with {permissions} for environment {environment} in organisation {organisation_pk}.
Fully update role {role_pk}'s environment grant {id} to environment {environment} in organisation {organisation_pk}.
PATCH /api/v1/organisations/{organisation_pk}/roles/{role_pk}/environments-permissions/{id}/ Adjust a role's environment permissions · Api v1 organisations roles environments permissions partial update #
Ask an LLM
“Can I just toggle environment admin on a role's existing grant?”
“Is it possible to change only the permission list on a role's environment grant?”
Tell an agent
Set environment admin to {admin} on grant {id} for role {role_pk} in organisation {organisation_pk}.
Change only the permissions on role {role_pk}'s environment grant {id} to {permissions} in organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/roles/{role_pk}/environments-permissions/{id}/ Revoke a role's environment permission grant · Api v1 organisations roles environments permissions destroy #
Ask an LLM
“How do I take away a role's access to an environment?”
“Can I delete one environment permission record from a role?”
Tell an agent destructive · confirm first
Delete environment permission {id} from role {role_pk} in organisation {organisation_pk}.
Revoke role {role_pk}'s environment grant {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/groups/ List groups assigned a role · Api v1 organisations roles groups list #
Ask an LLM
“Which user groups have been given a particular role?”
“Who inherits a role through group membership?”
Tell an agent
List groups assigned role {role_pk} in organisation {organisation_pk}.
Show the groups holding role {role_pk} in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/roles/{role_pk}/groups/ Assign a role to a group · Api v1 organisations roles groups create #
Ask an LLM
“How do I give a whole group a role at once?”
“Can I attach a role to an existing user group?”
Tell an agent
Assign role {role_pk} to group {group} in organisation {organisation_pk}.
Give group {group} the role {role_pk} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/groups/{id}/ Get a role-to-group assignment · Api v1 organisations roles groups retrieve #
Ask an LLM
“Can I look at one specific role-group assignment record?”
“Which group does a particular role assignment point to?”
Tell an agent
Show group assignment {id} for role {role_pk} in organisation {organisation_pk}.
Get role {role_pk}'s group link {id} in organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/roles/{role_pk}/groups/{id}/ Replace a role-to-group assignment · Api v1 organisations roles groups update #
Ask an LLM
“Can I repoint an existing role assignment to a different group?”
“What call fully replaces a role's group assignment?”
Tell an agent
Replace group assignment {id} on role {role_pk} with group {group} in organisation {organisation_pk}.
Fully update role {role_pk}'s group link {id} to point at group {group} in organisation {organisation_pk}.
PATCH /api/v1/organisations/{organisation_pk}/roles/{role_pk}/groups/{id}/ Partially update a role-to-group assignment · Api v1 organisations roles groups partial update #
Ask an LLM
“Can I change just the group on a role assignment without resending everything?”
“Is there a partial update for a role's group link?”
Tell an agent
Partially update group assignment {id} on role {role_pk} to group {group} in organisation {organisation_pk}.
Patch role {role_pk}'s group link {id} in organisation {organisation_pk} so it uses group {group}.
DELETE /api/v1/organisations/{organisation_pk}/roles/{role_pk}/groups/{id}/ Remove a role from a group assignment · Api v1 organisations roles groups destroy #
Ask an LLM
“How do I unassign a role from a group, working from the role's side?”
“Can I delete the link between a role and a group?”
Tell an agent destructive · confirm first
Delete group assignment {id} from role {role_pk} in organisation {organisation_pk}.
Unlink role {role_pk} from its group assignment {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/master-api-keys/ List admin API keys assigned a role · Api v1 organisations roles master api keys list #
Ask an LLM
“Which master API keys carry a given role?”
“What automation keys inherit this role's permissions?”
Tell an agent
List master API keys assigned role {role_pk} in organisation {organisation_pk}.
Show the admin keys holding role {role_pk} in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/roles/{role_pk}/master-api-keys/ Assign a role to an admin API key · Api v1 organisations roles master api keys create #
Ask an LLM
“How do I scope a master API key by giving it a role?”
“Can I attach a role to an existing admin key from the role's side?”
Tell an agent
Assign role {role_pk} to master API key {master_api_key} in organisation {organisation_pk}.
Give admin key {master_api_key} the role {role_pk} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/master-api-keys/{id}/ Get a role-to-admin-key assignment · Api v1 organisations roles master api keys retrieve #
Ask an LLM
“Can I view one record linking a role to a master API key?”
“Which admin key does a particular role assignment refer to?”
Tell an agent
Show master API key assignment {id} for role {role_pk} in organisation {organisation_pk}.
Get role {role_pk}'s admin key link {id} in organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/roles/{role_pk}/master-api-keys/{id}/ Replace a role-to-admin-key assignment · Api v1 organisations roles master api keys update #
Ask an LLM
“Can I repoint a role assignment to a different master API key?”
“What call fully replaces a role's admin key link?”
Tell an agent
Replace admin key assignment {id} on role {role_pk} with key {master_api_key} in organisation {organisation_pk}.
Fully update role {role_pk}'s master key link {id} to key {master_api_key} in organisation {organisation_pk}.
PATCH /api/v1/organisations/{organisation_pk}/roles/{role_pk}/master-api-keys/{id}/ Partially update a role-to-admin-key assignment · Api v1 organisations roles master api keys partial update #
Ask an LLM
“Can I change only the key on a role's master API key assignment?”
“Is there a patch call for a role's admin key link?”
Tell an agent
Partially update admin key assignment {id} on role {role_pk} to key {master_api_key} in organisation {organisation_pk}.
Patch role {role_pk}'s master key link {id} in organisation {organisation_pk} to use key {master_api_key}.
DELETE /api/v1/organisations/{organisation_pk}/roles/{role_pk}/master-api-keys/{id}/ Unassign a role from an admin API key · Api v1 organisations roles master api keys destroy #
Ask an LLM
“How do I remove a role from a master API key, starting from the role?”
“Can I delete a role's link to an admin key without deleting the key?”
Tell an agent destructive · confirm first
Delete admin key assignment {id} from role {role_pk} in organisation {organisation_pk}.
Unlink role {role_pk} from master key assignment {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/organisation-permissions/ List a role's organisation-wide permissions · Api v1 organisations roles organisation permissions list #
Ask an LLM
“What can a role do at the organisation level, like creating projects?”
“Which organisation permissions has this role been granted?”
Tell an agent
List organisation permissions for role {role_pk} in organisation {organisation_pk}.
Show the org-wide grants held by role {role_pk} in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/roles/{role_pk}/organisation-permissions/ Grant a role organisation-wide permissions · Api v1 organisations roles organisation permissions create #
Ask an LLM
“How do I let a role create projects or manage users across the organisation?”
“Can I add organisation-level permissions to a role?”
Tell an agent
Grant role {role_pk} organisation permissions {permissions} in organisation {organisation_pk}.
Give role {role_pk} org-level rights {permissions} for organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/organisation-permissions/{id}/ Get one organisation permission grant for a role · Api v1 organisations roles organisation permissions retrieve #
Ask an LLM
“Can I inspect a single organisation-level permission record on a role?”
“What does one of a role's org-wide grants contain?”
Tell an agent
Open the org-level permission record {id} that role {role_pk} holds across organisation {organisation_pk}.
Get role {role_pk}'s org-wide grant {id} in organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/roles/{role_pk}/organisation-permissions/{id}/ Replace a role's organisation permission grant · Api v1 organisations roles organisation permissions update #
Ask an LLM
“Can I overwrite a role's complete set of organisation-level permissions?”
“Which call replaces an org-wide permission grant on a role?”
Tell an agent
Replace organisation permission {id} on role {role_pk} with {permissions} in organisation {organisation_pk}.
Fully update role {role_pk}'s org-wide grant {id} in organisation {organisation_pk}.
PATCH /api/v1/organisations/{organisation_pk}/roles/{role_pk}/organisation-permissions/{id}/ Adjust a role's organisation permissions · Api v1 organisations roles organisation permissions partial update #
Ask an LLM
“Can I patch just the permission list on a role's organisation grant?”
“Is there a partial update for org-level role permissions?”
Tell an agent
Change only the permissions on organisation grant {id} for role {role_pk} to {permissions} in organisation {organisation_pk}.
Patch role {role_pk}'s org-wide grant {id} in organisation {organisation_pk} to {permissions}.
DELETE /api/v1/organisations/{organisation_pk}/roles/{role_pk}/organisation-permissions/{id}/ Revoke a role's organisation permission grant · Api v1 organisations roles organisation permissions destroy #
Ask an LLM
“How do I strip organisation-level rights from a role?”
“Can I delete one org-wide permission record from a role?”
Tell an agent destructive · confirm first
Remove org-wide rights record {id} so role {role_pk} loses organisation-level access in {organisation_pk}.
Revoke role {role_pk}'s org-wide grant {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/projects-permissions/ List a role's permissions in a project · Api v1 organisations roles projects permissions list #
Ask an LLM
“What can a role do inside one specific project?”
“Which project-level permissions has a role been granted?”
Tell an agent
List role {role_pk}'s permissions in project {project} for organisation {organisation_pk}.
Show project {project} permissions held by role {role_pk} in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/roles/{role_pk}/projects-permissions/ Grant a role permissions on a project · Api v1 organisations roles projects permissions create #
Ask an LLM
“How do I give a role access to create features in a project?”
“Can I make a role a project admin?”
Tell an agent
Grant role {role_pk} permissions {permissions} on project {project} in organisation {organisation_pk}.
Make role {role_pk} a project admin ({admin}) of {project} with permissions {permissions} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/roles/{role_pk}/projects-permissions/{id}/ Get one project permission grant for a role · Api v1 organisations roles projects permissions retrieve #
Ask an LLM
“Can I inspect a single project permission record on a role?”
“What exactly does one of a role's project grants allow?”
Tell an agent
Look up which project and permissions grant {id} gives role {role_pk} in organisation {organisation_pk}.
Get role {role_pk}'s project grant {id} in organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/roles/{role_pk}/projects-permissions/{id}/ Replace a role's project permission grant · Api v1 organisations roles projects permissions update #
Ask an LLM
“Can I overwrite the full permission list a role has on a project?”
“Which call replaces a project permission grant entirely?”
Tell an agent
Replace project permission {id} on role {role_pk} with {permissions} for project {project} in organisation {organisation_pk}.
Fully update role {role_pk}'s project grant {id} to project {project} in organisation {organisation_pk}.
PATCH /api/v1/organisations/{organisation_pk}/roles/{role_pk}/projects-permissions/{id}/ Adjust a role's project permissions · Api v1 organisations roles projects permissions partial update #
Ask an LLM
“Can I just toggle project admin on a role's existing project grant?”
“Is it possible to change only the permissions on a role's project grant?”
Tell an agent
Set project admin to {admin} on grant {id} for role {role_pk} in organisation {organisation_pk}.
Change only the permissions on role {role_pk}'s project grant {id} to {permissions} in organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/roles/{role_pk}/projects-permissions/{id}/ Revoke a role's project permission grant · Api v1 organisations roles projects permissions destroy #
Ask an LLM
“How do I take away a role's access to a project?”
“Can I delete one project permission record from a role?”
Tell an agent destructive · confirm first
Take project access away from role {role_pk} by deleting its project grant record {id} in organisation {organisation_pk}.
Revoke role {role_pk}'s project grant {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/scim/ Get an organisation's SCIM provisioning config · Api v1 organisations scim retrieve #
Ask an LLM
“Is SCIM user provisioning set up for my organisation?”
“Can I view the current SCIM configuration?”
Tell an agent
Show the SCIM configuration for organisation {organisation_pk}.
Check whether SCIM is enabled in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/scim/ Enable SCIM provisioning · Api v1 organisations scim create #
Ask an LLM
“How do I turn on SCIM so my identity provider can sync users?”
“Can I set up SCIM provisioning for an organisation through the API?”
Tell an agent
Enable SCIM provisioning for organisation {organisation_pk}.
Set up a SCIM configuration in organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/scim/ Disable SCIM provisioning · Api v1 organisations scim destroy #
Ask an LLM
“What happens when I remove the SCIM configuration from an organisation?”
“Can I switch off SCIM user sync?”
Tell an agent destructive · confirm first
Delete the SCIM configuration for organisation {organisation_pk}.
Turn off SCIM provisioning in organisation {organisation_pk}.
POST /api/v1/organisations/{organisation_pk}/scim/regenerate-token/ Regenerate the SCIM bearer token · Api v1 organisations scim regenerate token create #
Ask an LLM
“How do I rotate the SCIM token if it may have leaked?”
“Will regenerating the SCIM token break the existing identity provider connection?”
Tell an agent destructive · confirm first
Regenerate the SCIM token for organisation {organisation_pk}.
Rotate organisation {organisation_pk}'s SCIM credentials.
GET /api/v1/organisations/{organisation_pk}/trust-relationships/ List OIDC trust relationships · Api v1 organisations trust relationships list #
Ask an LLM
“Which external identity issuers are trusted to get API access to my organisation?”
“What trust relationships have been set up for keyless workload access?”
Tell an agent
List trust relationships for organisation {organisation_pk}.
Show page {page} of organisation {organisation_pk}'s trusted issuers.
POST /api/v1/organisations/{organisation_pk}/trust-relationships/ Trust an external token issuer · Api v1 organisations trust relationships create #
Ask an LLM
“Can I let CI jobs authenticate with their own OIDC tokens instead of a stored API key?”
“How do I register an issuer and audience as a trust relationship?”
Tell an agent
Create trust relationship {name} in organisation {organisation_pk} for issuer {issuer} and audience {audience}, admin {is_admin}.
Trust issuer {issuer} in organisation {organisation_pk} with claim rules {claim_rules}.
GET /api/v1/organisations/{organisation_pk}/trust-relationships/{id}/ Get a trust relationship's details · Api v1 organisations trust relationships retrieve #
Ask an LLM
“What issuer, audience and claim rules does one trust relationship use?”
“Does a given trust relationship grant admin access?”
Tell an agent
Show trust relationship {id} in organisation {organisation_pk}.
Get the claim rules of trust relationship {id} for organisation {organisation_pk}.
PUT /api/v1/organisations/{organisation_pk}/trust-relationships/{id}/ Replace a trust relationship · Api v1 organisations trust relationships update #
Ask an LLM
“Can I overwrite every setting of a trust relationship in one request?”
“Which call fully redefines a trusted issuer's configuration?”
Tell an agent
Replace trust relationship {id} in organisation {organisation_pk} with name {name}, issuer {issuer}, audience {audience}, admin {is_admin}.
Fully update trust relationship {id} of organisation {organisation_pk} to issuer {issuer}.
PATCH /api/v1/organisations/{organisation_pk}/trust-relationships/{id}/ Adjust a trust relationship · Api v1 organisations trust relationships partial update #
Ask an LLM
“Can I just change the claim rules on a trust relationship?”
“Is it possible to downgrade a trust relationship from admin without redefining it?”
Tell an agent
Set claim rules {claim_rules} on trust relationship {id} in organisation {organisation_pk}.
Change only is_admin to {is_admin} on trust relationship {id} of organisation {organisation_pk}.
DELETE /api/v1/organisations/{organisation_pk}/trust-relationships/{id}/ Delete a trust relationship · Api v1 organisations trust relationships destroy #
Ask an LLM
“How do I stop trusting an external issuer?”
“Can I delete a trust relationship so its tokens no longer work?”
Tell an agent destructive · confirm first
Delete trust relationship {id} from organisation {organisation_pk}.
Remove trusted issuer {id} in organisation {organisation_pk}.
GET /api/v1/organisations/{organisation_pk}/usage-data/ Get an organisation's API usage over time · Api v1 organisations usage data retrieve #
Ask an LLM
“How many flag and identity requests has my organisation made this billing period?”
“Can I break API usage down by project, environment or SDK version?”
Tell an agent
Get usage data for organisation {organisation_pk} over period {period}.
Show API usage for organisation {organisation_pk} in project {project_id} and environment {environment_id}.
GET /api/v1/organisations/{organisation_pk}/usage-data/total-count/ Get an organisation's total API request count · Api v1 organisations usage data total count retrieve #
Ask an LLM
“What's the single total number of API calls my organisation has made?”
“Can I get one headline usage count instead of a time series?”
Tell an agent
Get the total API request count for organisation {organisation_pk}.
Tell me organisation {organisation_pk}'s overall usage count.
GET /api/v1/organisations/{id}/ Get an organisation via the v1 endpoint · Api v1 organisations retrieve #
Ask an LLM
“Can I read an organisation's settings, like 2FA enforcement, from the /api/v1 organisations endpoint?”
“Does an organisation persist trait data or restrict project creation to admins?”
Tell an agent
Get organisation {id} from the v1 organisations endpoint.
Show the admin and 2FA settings of organisation {id}.
PUT /api/v1/organisations/{id}/ Replace an organisation's settings · Api v1 organisations update #
Ask an LLM
“Can I overwrite all of an organisation's settings in one request?”
“Which call fully replaces an organisation's name and options?”
Tell an agent
Fully update organisation {id} with name {name}.
Replace organisation {id}'s settings, naming it {name} and setting force_2fa to {force_2fa}.
PATCH /api/v1/organisations/{id}/ Change specific organisation settings · Api v1 organisations partial update #
Ask an LLM
“Can I enforce two-factor authentication for my whole organisation?”
“Is there a way to restrict project creation to organisation admins?”
Tell an agent
Turn force_2fa to {force_2fa} for organisation {id}.
Rename organisation {id} to {name}.
DELETE /api/v1/organisations/{id}/ Delete an organisation · Api v1 organisations destroy #
Ask an LLM
“How do I permanently delete an entire organisation?”
“Does deleting an organisation remove all of its projects too?”
Tell an agent destructive · confirm first
Delete organisation {id}.
Permanently remove organisation {id} and everything in it.
POST /api/v1/organisations/{id}/get-hosted-page-url-for-subscription-upgrade/ Get a hosted checkout link to upgrade a plan · Api v1 organisations get hosted page url for subscription upgrade create #
Ask an LLM
“How do I get a checkout page URL to upgrade my organisation's subscription?”
“Can I generate an upgrade link for a specific plan?”
Tell an agent
Get a hosted upgrade page for organisation {id} to plan {plan_id} on subscription {subscription_id}.
Create a subscription upgrade checkout link for organisation {id}, plan {plan_id}, subscription {subscription_id}.
GET /api/v1/organisations/{id}/get-subscription-metadata/ Get an organisation's subscription metadata · Api v1 organisations get subscription metadata retrieve #
Ask an LLM
“What seats, projects and API call allowances come with my organisation's subscription?”
“Can I read the subscription metadata that sets my plan's limits?”
Tell an agent
Get the subscription metadata for organisation {id}.
Show the plan allowances recorded on organisation {id}'s subscription.
GET /api/v1/organisations/{id}/influx-data/ Get usage data from the deprecated influx endpoint · Api v1 organisations influx data retrieve #
Ask an LLM
“Is the influx-data usage endpoint for organisations deprecated?”
“Can I still pull legacy influx usage figures for a project or environment?”
Tell an agent
Get legacy influx usage data for organisation {id}.
Fetch deprecated influx data for organisation {id}, project {project_id}, environment {environment_id}.
POST /api/v1/organisations/{id}/invite/ Invite people to an organisation by email · Api v1 organisations invite create #
Ask an LLM
“How do I invite teammates to my organisation by email?”
“Can I send several email invitations at once?”
Tell an agent
Invite {emails} to organisation {id}.
Send organisation {id} invitations {invites}.
GET /api/v1/organisations/{id}/my-permissions/ See my own permissions in an organisation · Api v1 organisations my permissions retrieve #
Ask an LLM
“What am I allowed to do in this organisation?”
“Am I an admin of the organisation I'm working in?”
Tell an agent
Show my permissions in organisation {id}.
Check whether I'm an admin of organisation {id}.
GET /api/v1/organisations/{id}/portal-url/ Get the billing portal link · Api v1 organisations portal url retrieve #
Ask an LLM
“Where do I manage billing and invoices for my organisation?”
“Can I get a link to the customer billing portal?”
Tell an agent
Get the billing portal URL for organisation {id}.
Give me a link to manage organisation {id}'s payment details.
POST /api/v1/organisations/{id}/remove-users/ Remove users from an organisation · Api v1 organisations remove users create #
Ask an LLM
“How do I remove people who've left the company from my organisation?”
“Can I kick several users out of an organisation in one request?”
Tell an agent destructive · confirm first
Remove user {user} from organisation {org}.
Take users {user} out of organisation {org} entirely.
POST /api/v1/organisations/{id}/update-subscription/ Apply a completed checkout to a subscription · Api v1 organisations update subscription create #
Ask an LLM
“After checkout, how do I apply the hosted page result to my organisation's subscription?”
“Can I update a subscription from a hosted page ID?”
Tell an agent
Update organisation {id}'s subscription from hosted page {hosted_page_id}.
Apply checkout {hosted_page_id} to the subscription of organisation {id}.
GET /api/v1/organisations/{id}/usage/ Get usage from the deprecated usage endpoint · Api v1 organisations usage retrieve #
Ask an LLM
“Is the older organisation usage endpoint deprecated in favour of total-count?”
“Can I still read the legacy usage figure for an organisation?”
Tell an agent
Get legacy usage for organisation {id}.
Read organisation {id}'s usage from the deprecated usage endpoint.
GET /api/v1/organisations/{id}/user-detailed-permissions/{user_id}/ See a user's detailed permissions · Api v1 organisations user detailed permissions retrieve #
Ask an LLM
“Where does a teammate's access come from — direct grants, groups or roles?”
“Can I see the detailed permissions another user has in an organisation?”
Tell an agent
Show detailed permissions for user {user_id} in organisation {id}.
Explain how user {user_id} gets their access in organisation {id}.
GET /api/v1/organisations/get-by-uuid/{uuid}/ Look up an organisation by its UUID · Api v1 organisations get by uuid retrieve #
Ask an LLM
“Can I find an organisation when I only have its UUID?”
“Which organisation does this UUID refer to?”
Tell an agent
Get the organisation with UUID {uuid}.
Resolve organisation UUID {uuid} to its name and ID.
GET /api/v1/organisations/permissions/ List the permission types organisations support · Api v1 organisations permissions retrieve #
Ask an LLM
“What organisation-level permission keys exist that I can grant?”
“Which permissions are available to assign at the organisation level?”
Tell an agent
List the available organisation permission types.
Show every permission key I can grant at organisation level.

Documentation

📖
Documentation
https://docs.flagsmith.com/integrating-with-flagsmith/flagsmith-api-overview/admin-api
📖
APIReference
https://docs.flagsmith.com/integrating-with-flagsmith/flagsmith-api-overview/management-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/flagsmith/refs/heads/main/openapi/flagsmith-organisations-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/flagsmith/refs/heads/main/asyncapi/flagsmith-webhooks-asyncapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/flagsmith/refs/heads/main/overlays/flagsmith-organisations-api-overlay.yaml
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/flagsmith/refs/heads/main/collections/flagsmith-organisations-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/flagsmith/refs/heads/main/collections/flagsmith-organisations-api.opencollection.json

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/flagsmith:flagsmith-organisations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

flagsmith-organisations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flagsmith Organisations API
  version: '1.0'
  description: 'Operations tagged Organisations across 2 of this provider''s published API definitions: flagsmith-admin-api-openapi.yml, flagsmith-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.flagsmith.com/api/v1
  description: Flagsmith Production API
tags:


# --- truncated at 32 KB (129 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flagsmith/refs/heads/main/openapi/flagsmith-organisations-api-openapi.yml