Skip to main content
Retrieve details of a specific organization by its ID or name.

​
Path Parameters

​
id
string
required
The organization identifier. Can be either:
  • Organization UUID (e.g., 9f256f86-d3c4-4a6e-b89a-1e9a23c5d78e)
  • Organization name/slug (e.g., acme-corp)

​
Response

​
organization
object
The organization object.
​
id
string
Unique identifier for the organization (UUID format).
​
name
string
Unique name/slug for the organization.
​
title
string
Human-readable display name for the organization.
​
avatar
string
URL to the organization’s avatar image.
​
state
string
Current state of the organization. Either enabled or disabled.
​
metadata
object
Custom metadata associated with the organization.
​
created_at
timestamp
Timestamp when the organization was created (RFC3339 format).
​
updated_at
timestamp
Timestamp when the organization was last updated (RFC3339 format).
curl -X GET 'https://api.frontier.example.com/v1beta1/organizations/9f256f86-d3c4-4a6e-b89a-1e9a23c5d78e' \
  -H 'Authorization: Bearer <token>'

​
Response Example

{
  "organization": {
    "id": "9f256f86-d3c4-4a6e-b89a-1e9a23c5d78e",
    "name": "acme-corp",
    "title": "Acme Corporation",
    "avatar": "https://example.com/avatars/acme.png",
    "state": "enabled",
    "metadata": {
      "industry": "technology",
      "size": "enterprise",
      "region": "us-west"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-20T14:22:00Z"
  }
}

​
Error Responses

​
code
string
Error code indicating the type of error.
​
message
string
Human-readable error message.

​
Common Errors

  • 400 Invalid Argument: Invalid UUID format provided
  • 401 Unauthorized: Invalid or missing authentication token
  • 404 Not Found: Organization doesn’t exist or user doesn’t have access
  • 500 Internal Server Error: Server encountered an unexpected error

​
Notes

  • You can use either the organization UUID or name as the identifier
  • Using the name is more convenient but UUIDs are more stable
  • The API automatically validates UUID format and returns a 400 error for invalid UUIDs
  • Disabled organizations can still be retrieved but may have limited functionality
  • Access is subject to authorization - users can only view organizations they’re members of or have permission to access

Build docs developers (and LLMs) love

Get started for freeTalk to us