Flagsmith · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flagsmith Organisations API

107 actions 107 updates phrasing extends openapi/flagsmith-organisations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Flagsmith's API. It is a proposal applied on top of the contract, not a document Flagsmith publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 107 · first 16 shown; the file carries all of them

$.info

$.paths['/organisations/'].get

$.paths['/organisations/{organisation_id}/'].get

$.paths['/api/v1/organisations/'].post

$.paths['/api/v1/organisations/{organisation_id}/licence'].put

$.paths['/api/v1/organisations/{organisation_pk}/api-usage-notification/'].get

$.paths['/api/v1/organisations/{organisation_pk}/github/create-cleanup-issue/'].post

$.paths['/api/v1/organisations/{organisation_pk}/github/issues/'].get

$.paths['/api/v1/organisations/{organisation_pk}/github/pulls/'].get

$.paths['/api/v1/organisations/{organisation_pk}/github/repo-contributors/'].get

$.paths['/api/v1/organisations/{organisation_pk}/github/repositories/'].get

$.paths['/api/v1/organisations/{organisation_pk}/groups/'].post

$.paths['/api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/'].get

$.paths['/api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/{id}/'].delete

$.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/'].get

$.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Flagsmith Organisations API
  version: 1.0.0
extends: openapi/flagsmith-organisations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 106
- target: $.paths['/organisations/'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organisations I belong to
      effect: read
      questions:
      - Which Flagsmith organisations does my account have access to?
      - Can I see every organisation I'm in along with its subscription and usage?
      instructions:
      - text: List all the organisations I have access to.
      - text: Show my organisations with their subscription details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organisations/{organisation_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organisation's plan and usage limits
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get the plan and usage limits for organisation {organisation_id}.
        slots:
          organisation_id: path.organisation_id
      - text: Show the subscription plan of organisation {organisation_id}.
        slots:
          organisation_id: path.organisation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new organisation
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create an organisation named {name}.
        slots:
          name: requestBody.name
      - text: Create organisation {name} with webhook notifications sent to {webhook_notification_email}.
        slots:
          name: requestBody.name
          webhook_notification_email: requestBody.webhook_notification_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_id}/licence'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload or replace an organisation's licence
      effect: write
      questions:
      - Where do I apply a self-hosted licence to my organisation?
      - Can I replace the licence attached to an organisation?
      instructions:
      - text: Update the licence for organisation {organisation_id}.
        slots:
          organisation_id: path.organisation_id
      - text: Apply a new licence file to organisation {organisation_id}.
        slots:
          organisation_id: path.organisation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/api-usage-notification/'].get
  update:
    x-apievangelist-phrasing:
      intent: List API usage notifications for an organisation
      effect: read
      questions:
      - Has my organisation been warned about approaching its API request limit?
      - What API usage alerts has an organisation received?
      instructions:
      - text: List API usage notifications for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show page {page} of organisation {organisation_pk}'s API usage alerts.
        slots:
          page: query.page
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/github/create-cleanup-issue/'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a GitHub issue to clean up stale flags
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a GitHub cleanup issue for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Raise a flag-removal cleanup issue in GitHub from organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/github/issues/'].get
  update:
    x-apievangelist-phrasing:
      intent: List GitHub issues from the linked integration
      effect: read
      questions:
      - Which GitHub issues can I link to a feature flag?
      - Can I browse issues from the GitHub repos connected to my organisation?
      instructions:
      - text: List GitHub issues available to organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show the GitHub issues I could attach to a flag in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/github/pulls/'].get
  update:
    x-apievangelist-phrasing:
      intent: List GitHub pull requests from the integration
      effect: read
      questions:
      - What pull requests from our GitHub repos can be linked to a flag?
      - Can I see open PRs through the organisation's GitHub integration?
      instructions:
      - text: List GitHub pull requests for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show the PRs visible through organisation {organisation_pk}'s GitHub connection.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/github/repo-contributors/'].get
  update:
    x-apievangelist-phrasing:
      intent: List contributors to a linked GitHub repo
      effect: read
      questions:
      - Who contributes to the GitHub repository we linked to Flagsmith?
      - Can I pull the contributor list of a connected repo?
      instructions:
      - text: List repo contributors from organisation {organisation_pk}'s GitHub integration.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show who contributes to the linked GitHub repo for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/github/repositories/'].get
  update:
    x-apievangelist-phrasing:
      intent: List GitHub repositories the integration can reach
      effect: read
      questions:
      - Which GitHub repositories has my organisation's integration been granted?
      - Can I see the repos available to connect to projects?
      instructions:
      - text: List GitHub repositories for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show the repos the GitHub app can access for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group in an organisation
      effect: write
      questions:
      - How do I create a permission group for my team?
      - Can I make a group that new users join by default?
      instructions:
      - text: Create group {name} in organisation {organisation_pk}.
        slots:
          name: requestBody.name
          organisation_pk: path.organisation_pk
      - text: Create group {name} in organisation {organisation_pk} with users {users}.
        slots:
          name: requestBody.name
          organisation_pk: path.organisation_pk
          users: requestBody.users
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles assigned to a group
      effect: read
      questions:
      - Which roles has a user group been given?
      - What roles does this group inherit permissions from?
      instructions:
      - text: List roles for group {group_pk} in organisation {organisation_pk}.
        slots:
          group_pk: path.group_pk
          organisation_pk: path.organisation_pk
      - text: Show the roles attached to group {group_pk} of organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          group_pk: path.group_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a role from a group
      effect: destructive
      questions:
      - 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?
      instructions:
      - text: Remove role {id} from group {group_pk} in organisation {organisation_pk}.
        slots:
          id: path.id
          group_pk: path.group_pk
          organisation_pk: path.organisation_pk
      - text: Unassign role {id} from group {group_pk} of organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          group_pk: path.group_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user group's details
      effect: read
      questions:
      - Who is in a particular group and is it a default group?
      - Can I view one group's full details including its members?
      instructions:
      - text: Show group {id} in organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Get the members of group {id} in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a group's settings and members
      effect: write
      questions:
      - Can I overwrite a group's name and full member list in one request?
      - What call replaces every field on an existing group?
      instructions:
      - text: Replace group {id} in organisation {organisation_pk} with name {name} and users {users}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
          name: requestBody.name
          users: requestBody.users
      - text: Fully update group {id} of organisation {organisation_pk}, renaming it {name}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user group
      effect: destructive
      questions:
      - How do I delete a group we no longer use?
      - Does deleting a group remove the users from the organisation too?
      instructions:
      - text: Delete group {id} from organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Remove the {id} group entirely from organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some settings on a group
      effect: write
      questions:
      - 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?
      instructions:
      - text: Rename group {id} in organisation {organisation_pk} to {name}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
          name: requestBody.name
      - text: Set is_default to {is_default} on group {id} of organisation {organisation_pk}.
        slots:
          is_default: requestBody.is_default
          id: path.id
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/add-users/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to a group
      effect: write
      questions:
      - How do I add several people to an existing group at once?
      - Can I put new teammates into a group by their user IDs?
      instructions:
      - text: Add users {user_ids} to group {id} in organisation {organisation_pk}.
        slots:
          user_ids: requestBody.user_ids
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Put user {user_ids} into group {id} of organisation {organisation_pk}.
        slots:
          user_ids: requestBody.user_ids
          id: path.id
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/{id}/remove-users/'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove users from a group
      effect: write
      questions:
      - 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?
      instructions:
      - text: Remove users {user_ids} from group {id} in organisation {organisation_pk}.
        slots:
          user_ids: requestBody.user_ids
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Take user {user_ids} out of group {id} of organisation {organisation_pk}.
        slots:
          user_ids: requestBody.user_ids
          id: path.id
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/my-groups/'].get
  update:
    x-apievangelist-phrasing:
      intent: List the groups I'm a member of
      effect: read
      questions:
      - Which groups am I personally a member of in this organisation?
      - Can I get a summary of just my own groups?
      instructions:
      - text: List my groups in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show summaries of the groups I belong to in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/groups/summaries/'].get
  update:
    x-apievangelist-phrasing:
      intent: List summaries of every group in an organisation
      effect: read
      questions:
      - What groups exist across the whole organisation?
      - Can I get a lightweight summary of all groups rather than full details?
      instructions:
      - text: List summaries of all groups in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Give me every group name in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/invite-links/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organisation's invite links
      effect: read
      questions:
      - Which shareable invite links are active for my organisation?
      - When do our existing invite links expire?
      instructions:
      - text: List invite links for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show the invite links and their roles for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/invite-links/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shareable invite link
      effect: write
      questions:
      - Can I generate a link anyone on my team can use to join the organisation?
      - Is it possible to set an expiry and role on a new invite link?
      instructions:
      - text: Create an invite link for organisation {organisation_pk} with role {role}.
        slots:
          organisation_pk: path.organisation_pk
          role: requestBody.role
      - text: Make an invite link for organisation {organisation_pk} that expires at {expires_at}.
        slots:
          organisation_pk: path.organisation_pk
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/invite-links/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an invite link
      effect: destructive
      questions:
      - How do I kill an invite link that got shared too widely?
      - Can I delete an invite link before it expires?
      instructions:
      - text: Delete invite link {id} from organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Revoke organisation {organisation_pk}'s invite link {id}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/invites/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pending email invite
      effect: read
      questions:
      - Who sent a particular email invite and when?
      - Can I check the details of one pending invitation?
      instructions:
      - text: Show invite {id} in organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Get the email and groups on pending invite {id} for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/invites/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending email invite
      effect: destructive
      questions:
      - Can I withdraw an email invitation someone hasn't accepted yet?
      - What's the way to cancel an invite sent to the wrong address?
      instructions:
      - text: Cancel invite {id} in organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Delete the pending email invite {id} from organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/invites/{id}/resend/'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend an email invite
      effect: write
      questions:
      - Can I resend an invitation email to someone who lost it?
      - What if an invitee never got the original invite email?
      instructions:
      - text: Resend invite {id} in organisation {organisation_pk} to {email}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
          email: requestBody.email
      - text: Send invite {id} again to {email} on behalf of {invited_by} in organisation {organisation_pk}.
        slots:
          id: path.id
          email: requestBody.email
          invited_by: requestBody.invited_by
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organisation's admin API keys
      effect: read
      questions:
      - Which organisation-level admin API keys exist and which are revoked?
      - Can I audit every master API key our organisation has issued?
      instructions:
      - text: List admin API keys for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show page {page} of organisation {organisation_pk}'s master API keys.
        slots:
          page: query.page
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organisation admin API key
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a master API key named {name} for organisation {organisation_pk}.
        slots:
          name: requestBody.name
          organisation_pk: path.organisation_pk
      - text: Create admin key {name} in organisation {organisation_pk} expiring on {expiry_date}.
        slots:
          name: requestBody.name
          organisation_pk: path.organisation_pk
          expiry_date: requestBody.expiry_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/{api_key_prefix}/roles/'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles attached to an admin API key
      effect: read
      questions:
      - What roles govern what a particular master API key can do?
      - Which roles are assigned to the key with a given prefix?
      instructions:
      - text: List roles for master API key {api_key_prefix} in organisation {organisation_pk}.
        slots:
          api_key_prefix: path.api_key_prefix
          organisation_pk: path.organisation_pk
      - text: Show the roles on admin key {api_key_prefix} of organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          api_key_prefix: path.api_key_prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/{api_key_prefix}/roles/{id}/detach-roles-from-master-api-key/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a role from an admin API key
      effect: destructive
      questions:
      - 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?
      instructions:
      - text: Detach role {id} from master API key {api_key_prefix} in organisation {organisation_pk}.
        slots:
          id: path.id
          api_key_prefix: path.api_key_prefix
          organisation_pk: path.organisation_pk
      - text: Remove role {id} from admin key {api_key_prefix} of organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          api_key_prefix: path.api_key_prefix
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin API key by prefix
      effect: read
      questions:
      - Is a given master API key still valid or has it expired?
      - Who created the admin key with this prefix?
      instructions:
      - text: Show master API key {prefix} in organisation {organisation_pk}.
        slots:
          prefix: path.prefix
          organisation_pk: path.organisation_pk
      - text: Check whether admin key {prefix} of organisation {organisation_pk} has expired.
        slots:
          organisation_pk: path.organisation_pk
          prefix: path.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin API key's settings
      effect: write
      questions:
      - 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?
      instructions:
      - text: Fully update master API key {prefix} in organisation {organisation_pk} with name {name}.
        slots:
          prefix: path.prefix
          organisation_pk: path.organisation_pk
          name: requestBody.name
      - text: Replace admin key {prefix} of organisation {organisation_pk}, setting expiry {expiry_date} and is_admin {is_admin}.
        slots:
          prefix: path.prefix
          organisation_pk: path.organisation_pk
          expiry_date: requestBody.expiry_date
          is_admin: requestBody.is_admin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin API key
      effect: destructive
      questions:
      - How do I delete a leaked organisation API key?
      - Will deleting a master API key break automations that use it?
      instructions:
      - text: Delete master API key {prefix} from organisation {organisation_pk}.
        slots:
          prefix: path.prefix
          organisation_pk: path.organisation_pk
      - text: Permanently remove admin key {prefix} in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          prefix: path.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/master-api-keys/{prefix}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Revoke or tweak an admin API key
      effect: write
      questions:
      - 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?
      instructions:
      - text: Set revoked to {revoked} on master API key {prefix} in organisation {organisation_pk}.
        slots:
          revoked: requestBody.revoked
          prefix: path.prefix
          organisation_pk: path.organisation_pk
      - text: Change only the expiry of admin key {prefix} in organisation {organisation_pk} to {expiry_date}.
        slots:
          prefix: path.prefix
          organisation_pk: path.organisation_pk
          expiry_date: requestBody.expiry_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/metadata-model-fields/'].get
  update:
    x-apievangelist-phrasing:
      intent: List metadata fields applied to models
      effect: read
      questions:
      - Which custom metadata fields are attached to features, segments or environments?
      - What metadata is required for which object types in my organisation?
      instructions:
      - text: List metadata model fields for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Show page {page} of organisation {organisation_pk}'s metadata field assignments.
        slots:
          page: query.page
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/metadata-model-fields/'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a metadata field to an object type
      effect: write
      questions:
      - 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?
      instructions:
      - text: Attach metadata field {field} to content type {content_type} in organisation {organisation_pk}.
        slots:
          field: requestBody.field
          content_type: requestBody.content_type
          organisation_pk: path.organisation_pk
      - text: Make field {field} on {content_type} required for {is_required_for} in organisation {organisation_pk}.
        slots:
          field: requestBody.field
          content_type: requestBody.content_type
          is_required_for: requestBody.is_required_for
          organisation_pk: path.organisation_pk
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/metadata-model-fields/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metadata field assignment
      effect: read
      questions:
      - What object type is a given metadata field assignment bound to?
      - Can I see whether one metadata model field is required?
      instructions:
      - text: Show metadata model field {id} in organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Get the requirement settings for metadata assignment {id} of organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/metadata-model-fields/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a metadata field assignment
      effect: write
      questions:
      - Can I fully redefine which field and object type a metadata assignment uses?
      - What call replaces a metadata model field in one go?
      instructions:
      - text: Replace metadata model field {id} in organisation {organisation_pk} with field {field} on {content_type}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
          field: requestBody.field
          content_type: requestBody.content_type
      - text: Fully update metadata assignment {id} of organisation {organisation_pk} to target {content_type}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
          content_type: requestBody.content_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/metadata-model-fields/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a metadata field from an object type
      effect: destructive
      questions:
      - 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?
      instructions:
      - text: Delete metadata model field {id} from organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Remove metadata assignment {id} in organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flagsmith/refs/heads/main/overlays/flagsmith-organisations-api-phrasing-overlay.yaml

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
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 overlay

curl "https://apis.io/api/v1/overlays/flagsmith-organisations-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?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.