Flagon API

v0.0.0

Base URLhttps://api.flagon.io

Token

Endpoints

post/ai/actions/executeExecute a confirmed agent action (human-in-the-loop)

Execute a confirmed agent action (human-in-the-loop)

Try it

Body

No token set (add one at the top).

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "input": null,
  "org_id": "string",
  "tool": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
inputobjectrequired
The tool input, as proposed
org_idstringrequired
toolstringrequired
The proposed tool name

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "result": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
resultobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/ai/actions/execute" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","input":null,"org_id":"string","tool":"string"}'

post/ai/messagesSend a message to the Flagon agent

Send a message to the Flagon agent

Try it

Body

No token set (add one at the top).

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "messages": null,
  "org_id": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
messagesobjectrequired
Conversation so far, ending with the new user message
org_idstringrequired
Organization the conversation is scoped to

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "proposals": null,
  "reply": "string",
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0
  }
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
proposalsobjectrequired
replystringrequired
usageUsagerequired
Show properties
- input_tokensinteger · int64required
- output_tokensinteger · int64required

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/ai/messages" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","messages":null,"org_id":"string"}'

post/internal/sso/provision-memberProvision an SSO-authenticated user into their org (internal)

Provision an SSO-authenticated user into their org (internal)

Try it

Body

No token set (add one at the top).

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "org_id": "string",
  "role": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
org_idstringrequired
The Flagon organization id bound to the SSO provider.
rolestring
Membership role to provision (default member).

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/internal/sso/provision-member" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","org_id":"string","role":"string"}'

get/invitations/{token}Look up an invitation by token

Look up an invitation by token

Try it

tokenpath*

No token set (add one at the top).

Parameters

tokenstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "email": "string",
  "expired": true,
  "id": "string",
  "inviter": "string",
  "org_name": "string",
  "org_slug": "string",
  "role": "string",
  "status": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
emailstringrequired
expiredbooleanrequired
idstringrequired
inviterstringrequired
org_namestringrequired
org_slugstringrequired
rolestringrequired
statusstringrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/invitations/{token}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/invitations/{token}/acceptAccept an invitation (internal)

Accept an invitation (internal)

Try it

tokenpath*

No token set (add one at the top).

Parameters

tokenstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "org_name": "string",
  "org_slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
org_namestringrequired
org_slugstringrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/invitations/{token}/accept" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/meCurrent user and their orgs

Current user and their orgs

Try it

No token set (add one at the top).

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "orgs": null,
  "user": {
    "created_at": "2026-01-01T00:00:00Z",
    "email": "string",
    "id": "string"
  }
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
orgsobjectrequired
userUserrequired
Show properties
- created_atstring · date-timerequired
- emailstringrequired
- idstringrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/me" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

put/me/deletedMirror the account's soft-delete state (internal)

Mirror the account's soft-delete state (internal)

Try it

Body

No token set (add one at the top).

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "deleted": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
deletedbooleanrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/me/deleted" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","deleted":true}'

put/me/profileMirror the caller's public profile (internal)

Mirror the caller's public profile (internal)

Try it

Body

No token set (add one at the top).

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "avatarUrl": "string",
  "bio": "string",
  "company": "string",
  "location": "string",
  "name": "string",
  "pronouns": "string",
  "publicEmail": "string",
  "socialLinks": null,
  "username": "string",
  "websiteUrl": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
avatarUrlstring
biostring
companystring
locationstring
namestring
pronounsstring
publicEmailstring
socialLinksobject
usernamestring
websiteUrlstring

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/me/profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","avatarUrl":"string","bio":"string","company":"string","location":"string","name":"string","pronouns":"string","publicEmail":"string","socialLinks":null,"username":"string","websiteUrl":"string"}'

get/me/tokensList your personal access tokens

List your personal access tokens

Try it

No token set (add one at the top).

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "tokens": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
tokensobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/me/tokens" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/me/tokensCreate a personal access token

Create a personal access token

Try it

Body

No token set (add one at the top).

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "expires_at": "2026-01-01T00:00:00Z",
  "expires_in_days": 0,
  "full": true,
  "name": "string",
  "scopes": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
expires_atstring · date-time
Absolute expiry (RFC3339). Takes precedence over expires_in_days.
expires_in_daysinteger · int64
0 = no expiry
fullboolean
Full access (no scope restriction)
namestringrequired
scopesobject
Scopes to grant (classic-style). Omit and set full=true for full access.

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "id": "string",
  "prefix": "string",
  "token": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
idstringrequired
prefixstringrequired
tokenstringrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/me/tokens" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","expires_at":"2026-01-01T00:00:00Z","expires_in_days":0,"full":true,"name":"string","scopes":null}'

delete/me/tokens/{id}Revoke a personal access token

Revoke a personal access token

Try it

idpath*

No token set (add one at the top).

Parameters

idstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/me/tokens/{id}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/notificationsList the caller's notifications

List the caller's notifications

Try it

limitquery

No token set (add one at the top).

Parameters

limitinteger · int64query
Max notifications to return

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "notifications": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
notificationsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/notifications?limit=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/notifications/read-allMark all the caller's notifications read

Mark all the caller's notifications read

Try it

No token set (add one at the top).

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/notifications/read-all" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/notifications/unread-countCount the caller's unread notifications

Count the caller's unread notifications

Try it

No token set (add one at the top).

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "count": 0
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
countinteger · int64required

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/notifications/unread-count" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/notifications/{id}/readMark a notification read

Mark a notification read

Try it

idpath*

No token set (add one at the top).

Parameters

idstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/notifications/{id}/read" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgsList the caller's orgs

List the caller's orgs

Try it

No token set (add one at the top).

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "orgs": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
orgsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgsCreate an organization

Create an organization

Try it

Body

No token set (add one at the top).

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "name": "string",
  "slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
namestringrequired
Display name
slugstring
URL slug; derived from the name when omitted

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "enforce_two_factor": true,
  "id": "string",
  "name": "string",
  "require_sso": true,
  "role": "string",
  "slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
enforce_two_factorbooleanrequired
idstringrequired
namestringrequired
require_ssobooleanrequired
rolestringrequired
slugstringrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","name":"string","slug":"string"}'

patch/orgs/{slug}Update an organization's settings

Update an organization's settings

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "name": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
namestringrequired
Display name

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "enforce_two_factor": true,
  "id": "string",
  "name": "string",
  "require_sso": true,
  "role": "string",
  "slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
enforce_two_factorbooleanrequired
idstringrequired
namestringrequired
require_ssobooleanrequired
rolestringrequired
slugstringrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PATCH "https://api.flagon.io/orgs/{slug}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","name":"string"}'

get/orgs/{slug}/auditList an organization's audit log

List an organization's audit log

Try it

slugpath*qqueryactionqueryactorquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
qstringquery
Search across summary, action, actor, and location
actionobjectquery
Filter to these action keys (repeatable)
actorstringquery
Filter to this actor's user id
limitinteger · int64query
Results per page (default 30, max 100)
cursorstringquery
Opaque cursor from a previous page's Link header

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "events": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
eventsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/audit?q=&action=&actor=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgs/{slug}/audit/configGet an organization's audit configuration

Get an organization's audit configuration

Try it

slugpath*

No token set (add one at the top).

Parameters

slugstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ip_disclosure": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
ip_disclosurebooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/audit/config" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

put/orgs/{slug}/audit/configUpdate an organization's audit configuration

Update an organization's audit configuration

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "ip_disclosure": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
ip_disclosurebooleanrequired
Reveal actor IP addresses in the audit log

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ip_disclosure": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
ip_disclosurebooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/orgs/{slug}/audit/config" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","ip_disclosure":true}'

get/orgs/{slug}/deleted-projectsList an organization's soft-deleted projects (restore archive)

List an organization's soft-deleted projects (restore archive)

Try it

slugpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "projects": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
projectsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/deleted-projects?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgs/{slug}/invitationsList an organization's pending invitations

List an organization's pending invitations

Try it

slugpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "invitations": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
invitationsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/invitations?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/invitationsInvite someone to an organization by email or username

Invite someone to an organization by email or username

Adds an existing Flagon user directly, or creates a pending invitation for an email that has no account yet. The response says which happened; for an invitation it returns a single-use token for the invite link.

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "login": "string",
  "role": "admin"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email address to invite, or the email/username of an existing user
rolestring · enum
Role to grant (default member)
adminmemberviewer

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "email": "string",
  "invitation": {
    "created_at": "2026-01-01T00:00:00Z",
    "email": "string",
    "expires_at": "2026-01-01T00:00:00Z",
    "id": "string",
    "inviter": null,
    "role": "string",
    "status": "string"
  },
  "org_name": "string",
  "status": "string",
  "token": "string",
  "user_id": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
emailstring
invitationInvitation
Show properties
- created_atstring · date-timerequired
- emailstringrequired
- expires_atstring · date-timerequired
- idstringrequired
- inviterobjectrequired
- rolestringrequired
- statusstringrequired
org_namestring
statusstringrequired
"added" or "invited"
tokenstring
Single-use invite token for the link (invited only)
user_idstring

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/invitations" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","login":"string","role":"admin"}'

delete/orgs/{slug}/invitations/{id}Revoke a pending invitation

Revoke a pending invitation

Try it

slugpath*idpath*

No token set (add one at the top).

Parameters

slugstringpathrequired
idstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/invitations/{id}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/leaveLeave an organization

Leave an organization

Try it

slugpath*

No token set (add one at the top).

Parameters

slugstringpathrequired
The organization slug

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/leave" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgs/{slug}/membersList an organization's members

List an organization's members

Try it

slugpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "members": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
membersobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/members?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/membersAdd an existing user to an organization

Add an existing user to an organization

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "login": "string",
  "role": "owner"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email or username of an existing Flagon user
rolestring · enum
Role to grant (default member)
owneradminmemberviewer

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/members" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","login":"string","role":"owner"}'

delete/orgs/{slug}/members/{userId}Remove a member from an organization

Remove a member from an organization

Try it

slugpath*userIdpath*

No token set (add one at the top).

Parameters

slugstringpathrequired
userIdstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/members/{userId}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

put/orgs/{slug}/members/{userId}/roleChange a member's role

Change a member's role

Try it

slugpath*userIdpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
userIdstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "role": "owner"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
owneradminmemberviewer

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/orgs/{slug}/members/{userId}/role" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","role":"owner"}'

get/orgs/{slug}/projectsList an organization's projects

List an organization's projects

Try it

slugpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "projects": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
projectsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/projects?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/projectsCreate a project

Create a project

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "description": "string",
  "name": "string",
  "readme": "string",
  "repository_url": "string",
  "slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestringrequired
Display name
readmestring
Markdown README
repository_urlstring
Source repository URL (linked source, later syncs the README)
slugstring
URL slug; derived from the name when omitted

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "created_by": "string",
  "deleted_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "readme": "string",
  "repository_url": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
created_bystringrequired
deleted_atstring · date-time
descriptionstringrequired
idstringrequired
namestringrequired
org_idstringrequired
readmestringrequired
repository_urlstringrequired
slugstringrequired
updated_atstring · date-timerequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/projects" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","description":"string","name":"string","readme":"string","repository_url":"string","slug":"string"}'

get/orgs/{slug}/projects/{project}Get a project

Get a project

Try it

slugpath*projectpath*expand[]query

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
expand[]objectquery
Related objects to inline, e.g. expand[]=organization

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "created_by": "string",
  "deleted_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "organization": {
    "$schema": "https://flagon.io",
    "created_at": "2026-01-01T00:00:00Z",
    "enforce_two_factor": true,
    "id": "string",
    "name": "string",
    "require_sso": true,
    "role": "string",
    "slug": "string"
  },
  "readme": "string",
  "repository_url": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
created_bystringrequired
deleted_atstring · date-time
descriptionstringrequired
idstringrequired
namestringrequired
org_idstringrequired
organizationOrg
Show properties
- $schemastring · uri
  A URL to the JSON Schema for this object.
- created_atstring · date-timerequired
- enforce_two_factorbooleanrequired
- idstringrequired
- namestringrequired
- require_ssobooleanrequired
- rolestringrequired
- slugstringrequired
readmestringrequired
repository_urlstringrequired
slugstringrequired
updated_atstring · date-timerequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/projects/{project}?expand[]=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

patch/orgs/{slug}/projects/{project}Update a project

Update a project

Try it

slugpath*projectpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "description": "string",
  "name": "string",
  "readme": "string",
  "repository_url": "string",
  "slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestring
Display name
readmestring
Markdown README
repository_urlstring
Source repository URL
slugstring
URL slug (renames the project)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "created_by": "string",
  "deleted_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "readme": "string",
  "repository_url": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
created_bystringrequired
deleted_atstring · date-time
descriptionstringrequired
idstringrequired
namestringrequired
org_idstringrequired
readmestringrequired
repository_urlstringrequired
slugstringrequired
updated_atstring · date-timerequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PATCH "https://api.flagon.io/orgs/{slug}/projects/{project}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","description":"string","name":"string","readme":"string","repository_url":"string","slug":"string"}'

delete/orgs/{slug}/projects/{project}Delete a project (soft delete; restorable)

Delete a project (soft delete; restorable)

Try it

slugpath*projectpath*expand[]query

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
expand[]objectquery
Related objects to inline, e.g. expand[]=organization

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "created_by": "string",
  "deleted_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "readme": "string",
  "repository_url": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
created_bystringrequired
deleted_atstring · date-time
descriptionstringrequired
idstringrequired
namestringrequired
org_idstringrequired
readmestringrequired
repository_urlstringrequired
slugstringrequired
updated_atstring · date-timerequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/projects/{project}?expand[]=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgs/{slug}/projects/{project}/membersList a project's collaborators

List a project's collaborators

Try it

slugpath*projectpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "members": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
membersobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/projects/{project}/members?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/projects/{project}/membersGrant an org member a role on a project

Grant an org member a role on a project

Try it

slugpath*projectpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "login": "string",
  "role": "read"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email or username of an existing org member
rolestring · enumrequired
Repository-style role to grant
readtriagewritemaintainadmin

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/projects/{project}/members" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","login":"string","role":"read"}'

delete/orgs/{slug}/projects/{project}/members/{userId}Revoke a collaborator's project role

Revoke a collaborator's project role

Try it

slugpath*projectpath*userIdpath*

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
userIdstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/projects/{project}/members/{userId}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

put/orgs/{slug}/projects/{project}/members/{userId}/roleChange a collaborator's project role

Change a collaborator's project role

Try it

slugpath*projectpath*userIdpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
userIdstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "role": "read"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
readtriagewritemaintainadmin

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/orgs/{slug}/projects/{project}/members/{userId}/role" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","role":"read"}'

get/orgs/{slug}/projects/{project}/ownersList a project's owners

List a project's owners

Try it

slugpath*projectpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "owners": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
ownersobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/projects/{project}/owners?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/projects/{project}/ownersAdd an owner (user or team) to a project

Add an owner (user or team) to a project

Try it

slugpath*projectpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "login": "string",
  "type": "user"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
For a user owner: an org member's email/username. For a team owner: the team slug.
typestring · enumrequired
Owner kind
userteam

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/projects/{project}/owners" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","login":"string","type":"user"}'

delete/orgs/{slug}/projects/{project}/owners/{type}/{principalId}Remove an owner from a project

Remove an owner from a project

Try it

slugpath*projectpath*typepath*principalIdpath*

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
typestring · enumpathrequired
principalIdstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/projects/{project}/owners/{type}/{principalId}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/projects/{project}/restoreRestore a soft-deleted project

Restore a soft-deleted project

Try it

slugpath*projectpath*expand[]query

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
expand[]objectquery
Related objects to inline, e.g. expand[]=organization

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "created_by": "string",
  "deleted_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "readme": "string",
  "repository_url": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
created_bystringrequired
deleted_atstring · date-time
descriptionstringrequired
idstringrequired
namestringrequired
org_idstringrequired
readmestringrequired
repository_urlstringrequired
slugstringrequired
updated_atstring · date-timerequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/projects/{project}/restore?expand[]=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgs/{slug}/projects/{project}/teamsList the teams with access to a project

List the teams with access to a project

Try it

slugpath*projectpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "teams": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
teamsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/projects/{project}/teams?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/projects/{project}/teamsGrant a team a role on a project

Grant a team a role on a project

Try it

slugpath*projectpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "role": "read",
  "team": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
Repository-style role to grant the team
readtriagewritemaintainadmin
teamstringrequired
Team slug

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/projects/{project}/teams" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","role":"read","team":"string"}'

delete/orgs/{slug}/projects/{project}/teams/{team}Revoke a team's access to a project

Revoke a team's access to a project

Try it

slugpath*projectpath*teampath*

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
teamstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/projects/{project}/teams/{team}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

put/orgs/{slug}/projects/{project}/teams/{team}/roleChange a team's role on a project

Change a team's role on a project

Try it

slugpath*projectpath*teampath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
projectstringpathrequired
teamstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "role": "read"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
readtriagewritemaintainadmin

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/orgs/{slug}/projects/{project}/teams/{team}/role" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","role":"read"}'

get/orgs/{slug}/securityGet an organization's security policy

Get an organization's security policy

Try it

slugpath*

No token set (add one at the top).

Parameters

slugstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "base_permission": "none",
  "enforce_two_factor": true,
  "require_sso": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
base_permissionstring · enumrequired
Default project access for members (none|read|triage|write|maintain|admin), raised by explicit grants.
nonereadtriagewritemaintainadmin
enforce_two_factorbooleanrequired
Whether members must have two-factor authentication enabled to access the org.
require_ssobooleanrequired
Whether members must sign in through the org's SSO provider.

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/security" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

put/orgs/{slug}/securityUpdate an organization's security policy

Update an organization's security policy

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "base_permission": "none",
  "enforce_two_factor": true,
  "require_sso": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
base_permissionstring · enumrequired
nonereadtriagewritemaintainadmin
enforce_two_factorbooleanrequired
require_ssobooleanrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "base_permission": "none",
  "enforce_two_factor": true,
  "require_sso": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
base_permissionstring · enumrequired
Default project access for members (none|read|triage|write|maintain|admin), raised by explicit grants.
nonereadtriagewritemaintainadmin
enforce_two_factorbooleanrequired
Whether members must have two-factor authentication enabled to access the org.
require_ssobooleanrequired
Whether members must sign in through the org's SSO provider.

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/orgs/{slug}/security" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","base_permission":"none","enforce_two_factor":true,"require_sso":true}'

get/orgs/{slug}/teamsList an organization's teams

List an organization's teams

Try it

slugpath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "teams": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
teamsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/teams?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/teamsCreate a team

Create a team

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "description": "string",
  "name": "string",
  "slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestringrequired
Display name
slugstring
URL slug; derived from the name when omitted

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "member_count": 0,
  "name": "string",
  "org_id": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
descriptionstringrequired
idstringrequired
member_countinteger · int64required
namestringrequired
org_idstring
slugstringrequired
updated_atstring · date-time

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/teams" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","description":"string","name":"string","slug":"string"}'

get/orgs/{slug}/teams/{team}Get a team

Get a team

Try it

slugpath*teampath*

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "member_count": 0,
  "name": "string",
  "org_id": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
descriptionstringrequired
idstringrequired
member_countinteger · int64required
namestringrequired
org_idstring
slugstringrequired
updated_atstring · date-time

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/teams/{team}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

patch/orgs/{slug}/teams/{team}Update a team

Update a team

Try it

slugpath*teampath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "description": "string",
  "name": "string",
  "slug": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestring
Display name
slugstring
URL slug (renames the team)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "created_at": "2026-01-01T00:00:00Z",
  "description": "string",
  "id": "string",
  "member_count": 0,
  "name": "string",
  "org_id": "string",
  "slug": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
descriptionstringrequired
idstringrequired
member_countinteger · int64required
namestringrequired
org_idstring
slugstringrequired
updated_atstring · date-time

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PATCH "https://api.flagon.io/orgs/{slug}/teams/{team}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","description":"string","name":"string","slug":"string"}'

delete/orgs/{slug}/teams/{team}Delete a team

Delete a team

Try it

slugpath*teampath*

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/teams/{team}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgs/{slug}/teams/{team}/membersList a team's members

List a team's members

Try it

slugpath*teampath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "members": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
membersobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/teams/{team}/members?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/teams/{team}/membersAdd an org member to a team

Add an org member to a team

Try it

slugpath*teampath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "login": "string",
  "role": "maintainer"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email or username of an existing org member
rolestring · enumrequired
Team role
maintainermember

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/teams/{team}/members" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","login":"string","role":"maintainer"}'

delete/orgs/{slug}/teams/{team}/members/{userId}Remove a member from a team

Remove a member from a team

Try it

slugpath*teampath*userIdpath*

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired
userIdstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/teams/{team}/members/{userId}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

put/orgs/{slug}/teams/{team}/members/{userId}/roleChange a team member's role

Change a team member's role

Try it

slugpath*teampath*userIdpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired
userIdstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "role": "maintainer"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
maintainermember

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X PUT "https://api.flagon.io/orgs/{slug}/teams/{team}/members/{userId}/role" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","role":"maintainer"}'

get/orgs/{slug}/teams/{team}/projectsList the projects a team has access to

List the projects a team has access to

Try it

slugpath*teampath*qquerylimitquerycursorquery

No token set (add one at the top).

Parameters

slugstringpathrequired
teamstringpathrequired
qstringquery
Free-text search filter
limitinteger · int64query
Max results per page (1-100, default 30)
cursorstringquery
Opaque keyset cursor from a prior page's Link header (rel=next)

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "projects": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
projectsobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/teams/{team}/projects?q=&limit=&cursor=" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/orgs/{slug}/tokensList an organization's access tokens

List an organization's access tokens

Try it

slugpath*

No token set (add one at the top).

Parameters

slugstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "tokens": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
tokensobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/orgs/{slug}/tokens" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

post/orgs/{slug}/tokensCreate an organization access token

Create an organization access token

Try it

slugpath*

Body

No token set (add one at the top).

Parameters

slugstringpathrequired

Request body

application/json · required

Example

{
  "$schema": "https://flagon.io",
  "expires_at": "2026-01-01T00:00:00Z",
  "expires_in_days": 0,
  "full": true,
  "name": "string",
  "role": "admin",
  "scopes": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
expires_atstring · date-time
Absolute expiry (RFC3339). Takes precedence over expires_in_days.
expires_in_daysinteger · int64
0 = no expiry
fullboolean
Full access (no scope restriction)
namestringrequired
rolestring · enum
Role the token acts with (default member)
adminmemberviewer
scopesobject

Responses

201Created

Example

{
  "$schema": "https://flagon.io",
  "id": "string",
  "prefix": "string",
  "token": "string"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
idstringrequired
prefixstringrequired
tokenstringrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X POST "https://api.flagon.io/orgs/{slug}/tokens" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $FLAGON_TOKEN" \
  -d '{"$schema":"https://flagon.io","expires_at":"2026-01-01T00:00:00Z","expires_in_days":0,"full":true,"name":"string","role":"admin","scopes":null}'

delete/orgs/{slug}/tokens/{id}Revoke an organization access token

Revoke an organization access token

Try it

slugpath*idpath*

No token set (add one at the top).

Parameters

slugstringpathrequired
idstringpathrequired

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "ok": true
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X DELETE "https://api.flagon.io/orgs/{slug}/tokens/{id}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

get/users/{username}Public user profile

Public user profile

Try it

usernamepath*

No token set (add one at the top).

Parameters

usernamestringpathrequired
The user's username

Responses

200OK

Example

{
  "$schema": "https://flagon.io",
  "avatar_url": null,
  "bio": null,
  "company": null,
  "created_at": "2026-01-01T00:00:00Z",
  "id": "string",
  "location": null,
  "name": null,
  "pronouns": null,
  "public_email": null,
  "social_links": null,
  "username": "string",
  "website_url": null
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
avatar_urlobjectrequired
bioobjectrequired
companyobjectrequired
created_atstring · date-timerequired
idstringrequired
locationobjectrequired
nameobjectrequired
pronounsobjectrequired
public_emailobjectrequired
social_linksobjectrequired
usernamestringrequired
website_urlobjectrequired

defaultError

Example

{
  "$schema": "https://flagon.io",
  "detail": "string",
  "errors": null,
  "instance": "https://flagon.io",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

Schema

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Example request

curl -X GET "https://api.flagon.io/users/{username}" \
  -H "Authorization: Bearer $FLAGON_TOKEN"

Models

AIExecuteInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
inputobjectrequired
The tool input, as proposed
org_idstringrequired
toolstringrequired
The proposed tool name

AIExecuteOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
resultobjectrequired

AIMessagesInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
messagesobjectrequired
Conversation so far, ending with the new user message
org_idstringrequired
Organization the conversation is scoped to

AcceptInvitationOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
org_namestringrequired
org_slugstringrequired

AccessTokenobject

created_atstring · date-timerequired
expires_atobject · date-timerequired
idstringrequired
kindstringrequired
last_used_atobject · date-timerequired
namestringrequired
prefixstringrequired
roleobjectrequired
scopesobjectrequired

AddMemberInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email or username of an existing Flagon user
rolestring · enum
Role to grant (default member)
owneradminmemberviewer

AddProjectMemberInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email or username of an existing org member
rolestring · enumrequired
Repository-style role to grant
readtriagewritemaintainadmin

AddProjectOwnerInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
For a user owner: an org member's email/username. For a team owner: the team slug.
typestring · enumrequired
Owner kind
userteam

AddProjectTeamInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
Repository-style role to grant the team
readtriagewritemaintainadmin
teamstringrequired
Team slug

AddTeamMemberInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email or username of an existing org member
rolestring · enumrequired
Team role
maintainermember

AiChatMessageobject

contentstringrequired
Message text
rolestring · enumrequired
Who sent the message
userassistant

AuditConfigInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
ip_disclosurebooleanrequired
Reveal actor IP addresses in the audit log

AuditConfigOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
ip_disclosurebooleanrequired

AuditOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
eventsobjectrequired

CreateOATInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
expires_atstring · date-time
Absolute expiry (RFC3339). Takes precedence over expires_in_days.
expires_in_daysinteger · int64
0 = no expiry
fullboolean
Full access (no scope restriction)
namestringrequired
rolestring · enum
Role the token acts with (default member)
adminmemberviewer
scopesobject

CreateOrgInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
namestringrequired
Display name
slugstring
URL slug; derived from the name when omitted

CreatePATInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
expires_atstring · date-time
Absolute expiry (RFC3339). Takes precedence over expires_in_days.
expires_in_daysinteger · int64
0 = no expiry
fullboolean
Full access (no scope restriction)
namestringrequired
scopesobject
Scopes to grant (classic-style). Omit and set full=true for full access.

CreateProjectInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestringrequired
Display name
readmestring
Markdown README
repository_urlstring
Source repository URL (linked source, later syncs the README)
slugstring
URL slug; derived from the name when omitted

CreateTeamInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestringrequired
Display name
slugstring
URL slug; derived from the name when omitted

CreateTokenOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
idstringrequired
prefixstringrequired
tokenstringrequired

ErrorDetailobject

locationstring
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
messagestring
Error message text
valueobject
The value at the given location

ErrorModelobject

$schemastring · uri
A URL to the JSON Schema for this object.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorsobject
Optional list of individual error details
instancestring · uri
A URI reference that identifies the specific occurrence of the problem.
statusinteger · int64
HTTP status code
titlestring
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
typestring · uri
A URI reference to human-readable documentation for the error.

Eventobject

actionstringrequired
actor_avatar_urlobjectrequired
actor_countryobjectrequired
actor_emailobjectrequired
actor_idobjectrequired
actor_ipobjectrequired
actor_nameobjectrequired
actor_user_agentobjectrequired
actor_usernameobjectrequired
created_atstring · date-timerequired
idstringrequired
summarystringrequired
target_idobjectrequired
target_typeobjectrequired

Invitationobject

created_atstring · date-timerequired
emailstringrequired
expires_atstring · date-timerequired
idstringrequired
inviterobjectrequired
rolestringrequired
statusstringrequired

InvitationsOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
invitationsobjectrequired

InviteLookupobject

$schemastring · uri
A URL to the JSON Schema for this object.
emailstringrequired
expiredbooleanrequired
idstringrequired
inviterstringrequired
org_namestringrequired
org_slugstringrequired
rolestringrequired
statusstringrequired

InviteMemberInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
loginstringrequired
Email address to invite, or the email/username of an existing user
rolestring · enum
Role to grant (default member)
adminmemberviewer

InviteMemberOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
emailstring
invitationInvitation
Show properties
- created_atstring · date-timerequired
- emailstringrequired
- expires_atstring · date-timerequired
- idstringrequired
- inviterobjectrequired
- rolestringrequired
- statusstringrequired
org_namestring
statusstringrequired
"added" or "invited"
tokenstring
Single-use invite token for the link (invited only)
user_idstring

LeaveOrgOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

MeOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
orgsobjectrequired
userUserrequired
Show properties
- created_atstring · date-timerequired
- emailstringrequired
- idstringrequired

Memberobject

avatar_urlobjectrequired
emailstringrequired
joined_atstring · date-timerequired
nameobjectrequired
rolestringrequired
user_idstringrequired
usernameobjectrequired

MembersOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
membersobjectrequired

Notificationobject

bodyobjectrequired
created_atstring · date-timerequired
idstringrequired
linkobjectrequired
org_idobjectrequired
read_atobject · date-timerequired
titlestringrequired
typestringrequired

NotificationsOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
notificationsobjectrequired

OKOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

Orgobject

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
enforce_two_factorbooleanrequired
idstringrequired
namestringrequired
require_ssobooleanrequired
rolestringrequired
slugstringrequired

OrgSecurityInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
base_permissionstring · enumrequired
nonereadtriagewritemaintainadmin
enforce_two_factorbooleanrequired
require_ssobooleanrequired

OrgSecurityOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
base_permissionstring · enumrequired
Default project access for members (none|read|triage|write|maintain|admin), raised by explicit grants.
nonereadtriagewritemaintainadmin
enforce_two_factorbooleanrequired
Whether members must have two-factor authentication enabled to access the org.
require_ssobooleanrequired
Whether members must sign in through the org's SSO provider.

OrgsOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
orgsobjectrequired

Projectobject

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
created_bystringrequired
deleted_atstring · date-time
descriptionstringrequired
idstringrequired
namestringrequired
org_idstringrequired
readmestringrequired
repository_urlstringrequired
slugstringrequired
updated_atstring · date-timerequired

ProjectDetailOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
created_bystringrequired
deleted_atstring · date-time
descriptionstringrequired
idstringrequired
namestringrequired
org_idstringrequired
organizationOrg
Show properties
- $schemastring · uri
  A URL to the JSON Schema for this object.
- created_atstring · date-timerequired
- enforce_two_factorbooleanrequired
- idstringrequired
- namestringrequired
- require_ssobooleanrequired
- rolestringrequired
- slugstringrequired
readmestringrequired
repository_urlstringrequired
slugstringrequired
updated_atstring · date-timerequired

ProjectMemberobject

avatar_urlobjectrequired
created_atstring · date-timerequired
emailstringrequired
nameobjectrequired
rolestringrequired
user_idstringrequired
usernameobjectrequired

ProjectMembersOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
membersobjectrequired

ProjectOwnerobject

avatar_urlobjectrequired
created_atstring · date-timerequired
emailobjectrequired
nameobjectrequired
owner_typestringrequired
principal_idstringrequired
team_slugobjectrequired
usernameobjectrequired

ProjectOwnersOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
ownersobjectrequired

ProjectTeamobject

created_atstring · date-timerequired
namestringrequired
rolestringrequired
slugstringrequired
team_idstringrequired

ProjectTeamsOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
teamsobjectrequired

ProjectsOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
projectsobjectrequired

Proposalobject

inputobjectrequired
summarystringrequired
toolstringrequired

ProvisionSSOInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
org_idstringrequired
The Flagon organization id bound to the SSO provider.
rolestring
Membership role to provision (default member).

PublicProfileobject

$schemastring · uri
A URL to the JSON Schema for this object.
avatar_urlobjectrequired
bioobjectrequired
companyobjectrequired
created_atstring · date-timerequired
idstringrequired
locationobjectrequired
nameobjectrequired
pronounsobjectrequired
public_emailobjectrequired
social_linksobjectrequired
usernamestringrequired
website_urlobjectrequired

Resultobject

$schemastring · uri
A URL to the JSON Schema for this object.
proposalsobjectrequired
replystringrequired
usageUsagerequired
Show properties
- input_tokensinteger · int64required
- output_tokensinteger · int64required

SetDeletedInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
deletedbooleanrequired

SetProjectMemberRoleInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
readtriagewritemaintainadmin

SetProjectTeamRoleInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
readtriagewritemaintainadmin

SetRoleInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
owneradminmemberviewer

SetTeamMemberRoleInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
rolestring · enumrequired
maintainermember

SyncProfileInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
avatarUrlstring
biostring
companystring
locationstring
namestring
pronounsstring
publicEmailstring
socialLinksobject
usernamestring
websiteUrlstring

SyncProfileOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
okbooleanrequired

Teamobject

$schemastring · uri
A URL to the JSON Schema for this object.
created_atstring · date-timerequired
descriptionstringrequired
idstringrequired
member_countinteger · int64required
namestringrequired
org_idstring
slugstringrequired
updated_atstring · date-time

TeamMemberobject

avatar_urlobjectrequired
created_atstring · date-timerequired
emailstringrequired
nameobjectrequired
rolestringrequired
user_idstringrequired
usernameobjectrequired

TeamMembersOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
membersobjectrequired

TeamProjectobject

created_atstring · date-timerequired
namestringrequired
project_idstringrequired
rolestringrequired
slugstringrequired

TeamProjectsOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
projectsobjectrequired

TeamsOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
teamsobjectrequired

TokensOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
tokensobjectrequired

UnreadCountOutputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
countinteger · int64required

UpdateOrgInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
namestringrequired
Display name

UpdateProjectInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestring
Display name
readmestring
Markdown README
repository_urlstring
Source repository URL
slugstring
URL slug (renames the project)

UpdateTeamInputBodyobject

$schemastring · uri
A URL to the JSON Schema for this object.
descriptionstring
One-line summary
namestring
Display name
slugstring
URL slug (renames the team)

Usageobject

input_tokensinteger · int64required
output_tokensinteger · int64required

Userobject

created_atstring · date-timerequired
emailstringrequired
idstringrequired