Skip to main content
GET
Get organization by ID
Retrieves organization details by ID.

Authentication

This endpoint requires authentication via Bearer token:
  • Authorization: Bearer <token>

Permissions

User must be a member of the organization (owner, admin, or member role).

Path Parameters

Response Fields

The response includes:

Example Request

Example Response

Common Errors

404 Not Found

The organization with the specified ID does not exist.

403 Forbidden

User is not a member of the organization.

Use Cases

  • Display organization details in dashboard
  • Verify organization membership before allowing access
  • Show organization settings to users
  • Check subscription status and plan
  • Display organization branding (logo, name)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

Organization retrieved successfully with details.

id
string
required
Example:

"5a2a307be93a2f00129ea035"

slug
string
required
Example:

"mi-empresa"

timezone
string
required
Example:

"America/Mexico_City"

created_at
string
required
Example:

"2017-05-05T20:55:33.468Z"

updated_at
string
required
Example:

"2017-05-05T20:55:33.468Z"

is_production_ready
boolean
required
Example:

true

customization
object
required
certificate
object
required
fiel
object
required
receipts
object
required
self_invoice
object
required
logo_url
string
Example:

"https://storage.example.com/organization/logo.jpg"

pending_steps
object[]