> ## Documentation Index > Fetch the complete documentation index at: https://docs.useorgx.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Describe the calling credential > Resolve who the calling credential is, which workspaces it reaches, and what it may do. This is the first call a client makes. Tenancy comes wholly from the credential, so the operation accepts no `workspace_id` — the response names every workspace the credential can reach and which one is the default. A key bound to a single workspace receives exactly that workspace and `workspace_scope: bound`. The shared service credential is refused: it describes no single principal. ## OpenAPI ````yaml /openapi/v1.yaml get /me openapi: 3.1.0 info: title: OrgX REST API v1 version: '1' description: >- Build accountable work into your product with OrgX REST API v1. Create work with one field, attach evidence when it is complete, and keep the receipt. Every authenticated request is scoped to the workspace resolved from your credential. Start with `POST /work`. Human guide: https://docs.useorgx.com/docs/api/quickstart contact: name: OrgX Support url: https://useorgx.com/support email: support@useorgx.com license: name: Proprietary url: https://useorgx.com/terms servers: - url: https://useorgx.com/api/v1 description: Production security: [] tags: - name: Work description: Create accountable work and complete it with evidence - name: Initiatives description: Organize related work around an outcome - name: Operating processes description: Evidence-backed company workflow/process lifecycle - name: Operating map description: Derived, rebuildable Operating Map projection over the process ledger - name: Discovery runs description: Wizard and deep-search workflow discovery over connected company sources - name: Handoffs description: Ledger-backed stage handoffs between operating-process stages - name: Events description: Replayable, workspace-scoped accepted ledger events - name: Projections description: Workspace-scoped, rebuildable read projections over OrgX sources - name: Episodes description: Mission-compatible Episode read adapters - name: Receipt validation description: Account-free Agent Work Receipt schema discovery and conformance - name: Receipt import description: Authenticated, workspace-scoped import into the hosted receipt ledger - name: Workload diagnosis description: >- Account-free evaluation of time, agents, systems, authority, and accountability boundaries - name: Content Studio description: >- Estimate, showcase, checkout, and payment event operations for Content Studio - name: Decisions description: Raise decisions for human ruling and read their state - name: Artifacts description: Register produced work against the entity it belongs to - name: Launches description: Preview and run an initiative launch through its spend gates - name: Runs description: Control agent runs with pause, resume, cancel, and rollback - name: Lifecycle description: Pause, resume, retry, or cancel work hierarchy nodes and runs - name: Deduplication description: Claim durable event fingerprints so duplicate triggers fire once - name: Credential description: >- Resolve the calling credential, the workspaces it reaches, and what it may do - name: API discovery description: Account-free error codes, request schemas, and closed vocabularies for v1 externalDocs: description: Human-readable OrgX REST API v1 reference url: https://docs.useorgx.com/docs/api/public-api paths: /me: get: tags: - Credential summary: Describe the calling credential description: >- Resolve who the calling credential is, which workspaces it reaches, and what it may do. This is the first call a client makes. Tenancy comes wholly from the credential, so the operation accepts no `workspace_id` — the response names every workspace the credential can reach and which one is the default. A key bound to a single workspace receives exactly that workspace and `workspace_scope: bound`. The shared service credential is refused: it describes no single principal. operationId: getCredentialIdentity responses: '200': description: The credential, its workspaces, its ceilings, and its limits content: application/json: schema: type: object required: - data - meta properties: data: type: object required: - principal - workspaces - default_workspace_id - limits - capabilities - api properties: principal: type: object required: - user_id - credential - api_key_id - workspace_scope properties: user_id: type: string credential: type: string enum: - session - api_key api_key_id: type: string nullable: true description: >- Identifier of the API key. Key material is withheld. workspace_scope: type: string enum: - bound - owner description: >- `bound` when the key is pinned to one workspace; `owner` when it reaches every workspace the owner has. workspaces: type: array items: type: object required: - id - name - is_default - created_at properties: id: type: string format: uuid name: type: string is_default: type: boolean created_at: type: string format: date-time default_workspace_id: type: string format: uuid nullable: true limits: type: object description: >- Declared ceilings per credential and per rate class. Live remaining counts are withheld because the fail-open path would publish an outage signal. properties: rate: type: object properties: read_per_min: type: integer write_per_min: type: integer generative_per_min: type: integer capabilities: type: array description: >- What this credential may and may not do, with the human surface for each refusal. items: type: object required: - name - allowed - reason properties: name: type: string allowed: type: boolean reason: type: string human_surface: type: string format: uri api: type: object properties: version: type: string errors_url: type: string format: uri schemas_url: type: string format: uri enums_url: type: string format: uri meta: type: object properties: apiVersion: type: string example: data: principal: user_id: 6b1f0a2c-9d4e-4a71-8c3b-2f5e7a9d1c04 credential: api_key api_key_id: 3d9c7e15-4b28-4f6a-9e13-8c0b5a2d7f41 workspace_scope: owner workspaces: - id: 5f82654a-055b-43d7-a86c-328788174d8e name: Growth is_default: true created_at: '2026-05-02T14:11:07.000Z' - id: 9a4d1b6e-7c25-4f83-b0e9-1d6c3a8f5b27 name: Platform is_default: false created_at: '2026-06-18T09:42:55.000Z' default_workspace_id: 5f82654a-055b-43d7-a86c-328788174d8e limits: rate: read_per_min: 120 write_per_min: 30 generative_per_min: 6 capabilities: - name: resolve_decision allowed: false reason: >- Decision resolution requires an interactive human session. No delegation primitive exists for a machine credential. human_surface: https://useorgx.com/decisions - name: create_workspace allowed: false reason: >- Workspaces are created in the OrgX app. The API reads the workspaces a credential already reaches. human_surface: https://useorgx.com/settings/workspaces api: version: '1' errors_url: https://useorgx.com/api/v1/errors schemas_url: https://useorgx.com/api/v1/meta/schemas enums_url: https://useorgx.com/api/v1/meta/enums meta: apiVersion: '1' '400': description: >- The shared service credential was used, or a workspace_id was supplied content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': $ref: '#/components/responses/Unauthorized' '503': $ref: '#/components/responses/ServiceUnavailable' security: - bearerAuth: [] - cookieAuth: [] components: schemas: ApiError: type: object properties: error: type: object properties: code: type: string message: type: string details: type: object requestId: type: string timestamp: type: string format: date-time docsUrl: type: string format: uri retryAfter: type: integer description: Seconds until rate limit resets responses: Unauthorized: description: Authentication required content: application/json: schema: $ref: '#/components/schemas/ApiError' ServiceUnavailable: description: Ledger or workspace authorization is unavailable content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: bearerAuth: type: http scheme: bearer description: 'OrgX API key, sent as `Authorization: Bearer oxk_...`' cookieAuth: type: apiKey in: cookie name: __session description: Session cookie from web authentication ````