---
title: "Gets a Company by its supplied guid"
method: GET
path: "/companies/{identifier}"
tags: ["companies"]
---

# Gets a Company by its supplied guid

`GET /companies/{identifier}`

Requires the privilege [`COMPANIES_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)

## Path parameters

- `identifier` string, required

## Query parameters

- `skipTeams` boolean

## Response `default`

default response

- CompanyResponse
  - `entitlements` CompanyEntitlementsResponse
    - `companyId` string
    - `companyName` string
    - `end` string, date-time
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `createdBy` string
    - `internal` boolean
    - `strict` boolean
    - `hasAgentBilling` boolean
    - `hasTrialBanners` boolean
    - `expired` boolean
    - `productFlags` object
    - `limits` object
    - `targetsTrackingPeriod` 'Daily' | 'Weekly' | 'Monthly'
  - `identifier` string
  - `name` string
  - `prefs` Prefs — Prefs for team
    - `autoAddUsers` boolean
    - `domain` string
    - `testRunRestrictionWindows` TestRunRestrictionWindow[]
      - `dayOfWeek` 'M' | 'T' | 'W' | 'Th' | 'F' | 'S' | 'Su', required
      - `windowsForDay` ScheduleWindow[], required
        - `start` string, required — Time in HH:mm format (24-hour)
        - `end` string, required — Time in HH:mm format (24-hour)
  - `samlIdpPrefs` SamlIdpPrefs
    - `entityId` string
    - `url` string
    - `cert` string
    - `certSecondary` string
    - `enabled` string
    - `forced` string
    - `claimsForced` string
  - `authMethodPrefs` AuthMethodPrefs
    - `allowSessionRenewal` boolean
    - `passwordEnabled` boolean
    - `mfaRequired` boolean
    - `googleEnabled` boolean
    - `oauthEnabled` boolean
    - `samlEnabled` boolean
    - `claimsRequired` boolean
    - `apiKeysEnabled` boolean
    - `apiKeysMaxSecondsToExpireEnabled` boolean
    - `apiKeysMaxSecondsToExpire` integer
    - `sessionDuration` integer
    - `samlAliasesEnabled` boolean
    - `allowedCidrBlocks` string[]
  - `internal` boolean
  - `createdBy` string
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `orgs` Info[]
    - `createdAt` string, date-time
    - `identifier` string
    - `name` string
    - `companyId` string
    - `updatedAt` string, date-time
    - `secretSetAt` string, date-time
    - `secretSetBy` string
    - `certificateSetAt` string, date-time
    - `certificateSetBy` string
    - `oldCertificateSetAt` string, date-time
    - `oldCertificateSetBy` string
    - `certificateExpiresOn` string, date-time
    - `oldCertificateExpiresOn` string, date-time
    - `certificateExpirationImminent` boolean
    - `oldCertificateExpirationImminent` boolean
    - `production` boolean
    - `prefs` Prefs — Prefs for team
      - `autoAddUsers` boolean
      - `domain` string
      - `testRunRestrictionWindows` TestRunRestrictionWindow[]
        - `dayOfWeek` 'M' | 'T' | 'W' | 'Th' | 'F' | 'S' | 'Su', required
        - `windowsForDay` ScheduleWindow[], required
          - `start` string, required — Time in HH:mm format (24-hour)
          - `end` string, required — Time in HH:mm format (24-hour)
    - `defaultTeamRole` string
    - `anyCertificateExpirationImminent` boolean
  - `alias` string
  - `defaultCompanyRole` string
  - `defaultTeamRole` string
  - `haltAllCoolDownEnd` string, date-time
  - `oauthSettings` OAuthSettings
    - `authorizationUri` string
    - `userInfoUri` string
    - `tokenUri` string
    - `clientId` string
    - `clientSecret` string
    - `scope` string
    - `enabled` boolean

## Other responses

- `401` — Authorization header missing or malformed. Please provide proper credentials in the authorization header.
- `403` — User requires privilege: COMPANIES_READ

---

[API](https://skmtc.net/gremlin/apis/gremlin-api.md) · [All operations](https://skmtc.net/gremlin/apis/gremlin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gremlin/gremlin-api/versions/70fe938a0b35/schema)
