Outception Docs

get
/v1/organizations/{id}

Get an organization by ID. **Scopes**: `organizations:read` `organizations:write`

curl -X GET "https://api.outception.com/v1/organizations/{id}" \
  -H "Authorization: Bearer $OUTCEPTION_TOKEN" \
  -H "Accept: application/json"

Path parameters

  • id

    string

    required

Response · 200

Successful Response

  • created_at

    string

    required

    Creation timestamp of the object.

  • modified_at

    string | null

    required

    Last modification timestamp of the object.

  • id

    string

    required

    The ID of the object.

  • name

    string

    required

    Organization name shown in emails, etc.

  • slug

    string

    required

    Unique organization slug used in credit card statements.

  • avatar_url

    string | null

    required

    Avatar URL shown in emails, etc.

  • email

    string | null

    required

    Public support email.

  • website

    string | null

    required

    Official website of the organization.

  • socials

    array<OrganizationSocialLink>

    required

    Links to social profiles.

    • platform

      enum

      required

      The social platform of the URL

    • url

      string

      required

      The URL to the organization profile

  • status

    enum

    required

    Current organization status

  • country

    enum | null

    Two-letter country code (ISO 3166-1 alpha-2).

  • capabilities

    OrganizationCapabilities

    required

    Capabilities currently granted to the organization.

    • api_access

      boolean

      required

      Whether the organization can access the API.

    • dashboard_access

      boolean

      required

      Whether the organization can access the dashboard.

Errors

  • 404

    Organization not found.

  • 422

    Validation Error