Organization Teams

Returns the list of teams in your organization with their details.

Availability: This endpoint is available to enterprise customers with organizations enabled. Contact your account team or support@fal.ai to request access.

Must be called with a key on the organization’s root team.

Key Features:

List all teams within the organization
Identify the organization’s root team via is_org_root
View team usernames and display names

See fal.ai docs for more details.

Required permissions: account:users:read. Key presets that include them: BILLING, FULL. See key permissions.

GET

organization

teams

Organization Teams

curl --request GET \
  --url https://api.fal.ai/v1/organization/teams \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/organization/teams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "teams": [
    {
      "username": "acme-corp",
      "name": "Acme Corporation",
      "is_org_root": true,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "username": "acme-ml-team",
      "name": "ML Research Team",
      "is_org_root": false,
      "created_at": "2024-03-01T14:00:00Z"
    }
  ]
}

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

Key on the BILLING preset, or any key whose permissions include the ones this API lists. Prefix it with "Key ", e.g. Authorization: Key YOUR_API_KEY

Response

Organization teams retrieved successfully

Response containing organization team details

teams

object[]

required

List of teams in the organization

Hide child attributes

teams.username

string

required

Team username/identifier (unique within the organization)

Example:

"acme-corp"

teams.name

string

required

Human-readable display name of the team

Example:

"Acme Corporation"

teams.is_org_root

boolean

required

True if this is the root organization team; false for sub-teams

Example:

true

teams.created_at

string

required

Team creation timestamp in ISO8601 format

Example:

"2024-01-15T10:30:00Z"

⌘I

Organization Teams

curl --request GET \
  --url https://api.fal.ai/v1/organization/teams \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.fal.ai/v1/organization/teams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "teams": [
    {
      "username": "acme-corp",
      "name": "Acme Corporation",
      "is_org_root": true,
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "username": "acme-ml-team",
      "name": "ML Research Team",
      "is_org_root": false,
      "created_at": "2024-03-01T14:00:00Z"
    }
  ]
}

{
  "error": {
    "type": "validation_error",
    "message": "Invalid request parameters"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}