Organizations#

Organization management

Check organization slug availability#

GET/organizations/check-slug

Check if an organization slug is available and get suggestions if not

Parameters#

Name	Type	Location	Required	Description
`slug`	string	query	Yes	The slug to check

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/check-slug?slug=string" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/check-slug?slug=string", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "available": false,
  "slug": "my-company",
  "suggestions": [
    "my-company-2",
    "my-company-inc",
    "my-company-io"
  ],
  "error": "Slug must match pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

List organizations#

GET/organizations

List organizations where user is a member

Parameters#

Name	Type	Location	Required	Description
`offset`	integer	query	No	Number of items to skip
`limit`	integer	query	No	Maximum number of items to return

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations?offset=0&limit=20" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations?offset=0&limit=20", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Corp",
      "slug": "acme-corp",
      "owner_id": "550e8400-e29b-41d4-a716-446655440000",
      "billing_email": "billing@acme.com",
      "status": "active",
      "created_at": "2025-10-02T15:30:00Z",
      "updated_at": "2025-10-02T15:30:00Z",
      "settings": {}
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 1,
    "total": 0
  }
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Create organization#

POST/organizations

Create new organization (user becomes owner)

Request Body#

{
  "name": "string",
  "slug": "string",
  "billing_email": "user@example.com",
  "settings": {}
}

Code Examples#

curl -X POST "https://platform.antfly.io/api/v1/organizations" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"slug": "string",
"billing_email": "user@example.com",
"settings": {}
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations", {
method: "POST",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "name": "string",
  "slug": "string",
  "billing_email": "user@example.com",
  "settings": {}
})
});

const data = await response.json();

Responses#

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "owner_id": "550e8400-e29b-41d4-a716-446655440000",
  "billing_email": "billing@acme.com",
  "status": "active",
  "created_at": "2025-10-02T15:30:00Z",
  "updated_at": "2025-10-02T15:30:00Z",
  "settings": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Get organization#

GET/organizations/{org_id}

Get organization details

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "owner_id": "550e8400-e29b-41d4-a716-446655440000",
  "billing_email": "billing@acme.com",
  "status": "active",
  "created_at": "2025-10-02T15:30:00Z",
  "updated_at": "2025-10-02T15:30:00Z",
  "settings": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Update organization#

PATCH/organizations/{org_id}

Update organization (requires admin+ role)

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Request Body#

{
  "name": "string",
  "billing_email": "user@example.com",
  "settings": {}
}

Code Examples#

curl -X PATCH "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"billing_email": "user@example.com",
"settings": {}
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000", {
method: "PATCH",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "name": "string",
  "billing_email": "user@example.com",
  "settings": {}
})
});

const data = await response.json();

Responses#

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "owner_id": "550e8400-e29b-41d4-a716-446655440000",
  "billing_email": "billing@acme.com",
  "status": "active",
  "created_at": "2025-10-02T15:30:00Z",
  "updated_at": "2025-10-02T15:30:00Z",
  "settings": {}
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Delete organization#

DELETE/organizations/{org_id}

Delete organization (requires owner role)

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Code Examples#

curl -X DELETE "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000", {
method: "DELETE",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

No response body

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

List organization members#

GET/organizations/{org_id}/members

List all members of organization

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`offset`	integer	query	No	Number of items to skip
`limit`	integer	query	No	Maximum number of items to return

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members?offset=0&limit=20" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members?offset=0&limit=20", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "role": "owner",
      "invited_by": "550e8400-e29b-41d4-a716-446655440000",
      "invited_at": "2025-10-02T15:30:00Z",
      "joined_at": "2025-10-02T15:30:00Z",
      "status": "invited",
      "metadata": {},
      "user": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "email": "user@example.com",
        "display_name": "John Doe",
        "avatar_url": "https://example.com/avatar.jpg",
        "created_at": "2025-10-02T15:30:00Z",
        "updated_at": "2025-10-02T15:30:00Z",
        "last_login_at": "2025-10-02T15:30:00Z",
        "status": "active",
        "settings": {}
      }
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 1,
    "total": 0
  }
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Invite member#

POST/organizations/{org_id}/members

Invite user to organization (requires admin+ role)

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Request Body#

{
  "email": "user@example.com",
  "role": "owner"
}

Code Examples#

curl -X POST "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"role": "owner"
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members", {
method: "POST",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "email": "user@example.com",
  "role": "owner"
})
});

const data = await response.json();

Responses#

{
  "invitation_id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@example.com",
  "role": "owner",
  "expires_at": "2025-10-02T15:30:00Z",
  "status": "invited",
  "token": "string"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Update member role#

PATCH/organizations/{org_id}/members/{member_id}

Update organization member role (requires admin+ role, cannot change owner)

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`member_id`	string	path	Yes	Member ID

Request Body#

{
  "role": "admin"
}

Code Examples#

curl -X PATCH "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"role": "admin"
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000", {
method: "PATCH",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "role": "admin"
})
});

const data = await response.json();

Responses#

{
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "role": "string",
  "updated_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Remove member#

DELETE/organizations/{org_id}/members/{member_id}

Remove user from organization (requires admin+ role)

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`member_id`	string	path	Yes	Member ID

Code Examples#

curl -X DELETE "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000", {
method: "DELETE",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

No response body

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Update member metadata#

PATCH/organizations/{org_id}/members/{member_id}/metadata

Replace organization-scoped metadata for a member's role context.

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`member_id`	string	path	Yes	Member ID

Request Body#

{
  "metadata": {}
}

Code Examples#

curl -X PATCH "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/metadata" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"metadata": {}
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/members/550e8400-e29b-41d4-a716-446655440000/metadata", {
method: "PATCH",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "metadata": {}
})
});

const data = await response.json();

Responses#

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "role": "owner",
  "invited_by": "550e8400-e29b-41d4-a716-446655440000",
  "invited_at": "2025-10-02T15:30:00Z",
  "joined_at": "2025-10-02T15:30:00Z",
  "status": "invited",
  "metadata": {},
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "user@example.com",
    "display_name": "John Doe",
    "avatar_url": "https://example.com/avatar.jpg",
    "created_at": "2025-10-02T15:30:00Z",
    "updated_at": "2025-10-02T15:30:00Z",
    "last_login_at": "2025-10-02T15:30:00Z",
    "status": "active",
    "settings": {}
  }
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Transfer organization ownership#

POST/organizations/{org_id}/transfer-ownership

Transfer organization ownership to another admin (requires owner role + password confirmation or OAuth re-authentication)

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Request Body#

{
  "new_owner_id": "550e8400-e29b-41d4-a716-446655440000",
  "password": "string",
  "reauth_verified": true
}

Code Examples#

curl -X POST "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/transfer-ownership" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"new_owner_id": "550e8400-e29b-41d4-a716-446655440000",
"password": "string",
"reauth_verified": true
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/transfer-ownership", {
method: "POST",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "new_owner_id": "550e8400-e29b-41d4-a716-446655440000",
  "password": "string",
  "reauth_verified": true
})
});

const data = await response.json();

Responses#

{
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "old_owner_id": "550e8400-e29b-41d4-a716-446655440000",
  "new_owner_id": "550e8400-e29b-41d4-a716-446655440000",
  "transferred_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Get organization MFA policy#

GET/organizations/{org_id}/mfa-policy

Get the persisted organization MFA enforcement policy. The extensible organization settings object cannot override this policy.

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/mfa-policy" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/mfa-policy", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "require_two_factor": true
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Enable organization MFA policy#

PATCH/organizations/{org_id}/mfa-policy

Enables MFA enforcement for a legacy organization. Public API callers cannot disable an active policy.

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID

Request Body#

{
  "require_two_factor": true
}

Code Examples#

curl -X PATCH "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/mfa-policy" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"require_two_factor": true
}'

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/mfa-policy", {
method: "PATCH",
headers: {
  Authorization: "Bearer YOUR_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "require_two_factor": true
})
});

const data = await response.json();

Responses#

{
  "require_two_factor": true
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Get invitation details#

GET/invitations/{token}

Retrieve invitation details by token (public endpoint)

Parameters#

Name	Type	Location	Required	Description
`token`	string	path	Yes	Invitation token

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/invitations/string" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/invitations/string", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "invitation_id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@example.com",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_name": "string",
  "role": "string",
  "expires_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Revoke invitation#

DELETE/invitations/{token}

Revoke an invitation token (requires authentication - only inviter or org admin/owner can revoke)

Parameters#

Name	Type	Location	Required	Description
`token`	string	path	Yes	Invitation token

Code Examples#

curl -X DELETE "https://platform.antfly.io/api/v1/invitations/string" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/invitations/string", {
method: "DELETE",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

No response body

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Accept invitation#

POST/invitations/{token}/accept

Accept an invitation token and create membership (requires authenticated user)

Parameters#

Name	Type	Location	Required	Description
`token`	string	path	Yes	Invitation token

Code Examples#

curl -X POST "https://platform.antfly.io/api/v1/invitations/string/accept" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/invitations/string/accept", {
method: "POST",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "role": "string",
  "joined_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Resend invitation#

POST/invitations/{token}/resend

Resend invitation email with a new token (requires authentication - only inviter or org admin/owner can resend)

Parameters#

Name	Type	Location	Required	Description
`token`	string	path	Yes	Original invitation token

Code Examples#

curl -X POST "https://platform.antfly.io/api/v1/invitations/string/resend" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/invitations/string/resend", {
method: "POST",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "message": "Invitation email resent successfully",
  "new_token": "string",
  "expires_at": "2025-10-02T15:30:00Z"
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}