Skip to main content
GET
/
organizations
/
{id}
Get organization by ID
curl --request GET \
  --url http://sandbox.mintlify.com/organizations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "5a2a307be93a2f00129ea035",
  "slug": "mi-empresa",
  "timezone": "America/Mexico_City",
  "created_at": "2017-05-05T20:55:33.468Z",
  "updated_at": "2017-05-05T20:55:33.468Z",
  "is_production_ready": true,
  "legal": {
    "name": "Mi Empresa",
    "legal_name": "Mi Empresa SA de CV",
    "tax_system": "601",
    "website": "https://miempresa.com",
    "phone": "+52 555 123 4567",
    "rfc": "EKU9003173C9",
    "zip": "86500",
    "address": {
      "street": "Blvd. Atardecer",
      "exterior": "142",
      "interior": "4",
      "neighborhood": "Centro",
      "city": "Huatabampo",
      "municipality": "Huatabampo",
      "zip": "86500",
      "state": "Sonora"
    }
  },
  "customization": {
    "has_logo": true,
    "color": "BADA55",
    "next_folio_number": 123,
    "next_folio_number_test": 123,
    "pdf_extra": {
      "codes": true,
      "address_codes": true,
      "product_key": true,
      "round_unit_price": false,
      "tax_breakdown": true,
      "ieps_breakdown": true,
      "render_carta_porte": false,
      "repeat_signature": false
    }
  },
  "certificate": {
    "has_certificate": true,
    "updated_at": "2023-05-05T20:55:33.468Z",
    "expires_at": "2025-05-05T20:55:33.468Z",
    "serial_number": "30001000000300000101"
  },
  "fiel": {
    "has_fiel": true,
    "updated_at": "2023-05-05T20:55:33.468Z",
    "expires_at": "2025-05-05T20:55:33.468Z",
    "serial_number": "30001000000300000101"
  },
  "receipts": {
    "periodicity": "day",
    "duration_days": 7,
    "next_folio_number": 123,
    "next_folio_number_test": 123
  },
  "self_invoice": {
    "allowed_cfdi_uses": [
      "G01",
      "G03"
    ],
    "apply_resico_isr": true,
    "support_email": "soporte@miempresa.com",
    "support_email_verified": true
  },
  "logo_url": "https://storage.example.com/organization/logo.jpg",
  "pending_steps": [
    {
      "type": "legal",
      "description": "Complete legal information"
    }
  ]
}
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

ParameterTypeRequiredDescription
idstringYesOrganization UUID

​
Response Fields

The response includes:
FieldTypeDescription
idstringOrganization UUID
namestringOrganization name
slugstringURL-friendly identifier
logostringLogo URL (if set)
planstringSubscription plan (free, pro, enterprise)
ownerIdstringOwner user UUID
stripeCustomerIdstringStripe customer ID (if exists)
subscriptionStatusstringCurrent subscription status
createdAtstringISO 8601 timestamp
updatedAtstringISO 8601 timestamp

​
Example Request

curl -X GET http://localhost:3001/api/organizations/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer <your_token>"

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "logo": "https://example.com/logo.png",
  "plan": "pro",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "stripeCustomerId": "cus_ABC123",
  "subscriptionStatus": "active",
  "subscriptionPeriodEnd": "2026-01-26T10:00:00Z",
  "createdAt": "2025-01-26T10:00:00Z",
  "updatedAt": "2025-12-26T10:00:00Z"
}

​
Common Errors

​
404 Not Found

The organization with the specified ID does not exist. 
{
  "statusCode": 404,
  "message": "Organization not found"
}

​
403 Forbidden

User is not a member of the organization. 
{
  "statusCode": 403,
  "message": "Access denied. User is not a member of this 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

​
legal
object
required
​
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[]