Ocriva Logo

Documents

Projects

Retrieve project information for the token's organization or project scope.

apiopenapiprojects

Published: 3/31/2026

Projects

The Projects endpoint lets you inspect which projects are accessible to your API key. This is useful for validating token scope, discovering project IDs, and building dynamic integrations that select the correct project at runtime.


List Projects

GET /v1/openapi/projects

Returns project information based on the token's scope.

  • Organization tokens — returns all active projects belonging to the organization.
  • Project tokens — returns a single-element array containing the scoped project.

The response is always an array, regardless of token type, so your client code can handle both cases uniformly.

Headers:

HeaderValueRequired
X-API-Keyocr_your_api_keyYes

Example Request:

curl "https://api.ocriva.com/v1/openapi/projects" \
  -H "X-API-Key: ocr_your_api_key"

Example Response — Organization Token (200 OK):

[
  {
    "id": "68db4aa2967d9c03fa9b5e74",
    "name": "Invoice Processing",
    "description": "Automated invoice extraction pipeline",
    "organizationId": "68da2880b45d7a01d90a3c51",
    "isActive": true,
    "createdAt": "2026-01-10T09:00:00.000Z",
    "updatedAt": "2026-03-15T16:45:00.000Z"
  },
  {
    "id": "68db5cc4c78g1e17gd4c7h85",
    "name": "Receipt Scanning",
    "description": "Mobile receipt scanning for expense reports",
    "organizationId": "68da2880b45d7a01d90a3c51",
    "isActive": true,
    "createdAt": "2026-02-01T11:00:00.000Z",
    "updatedAt": "2026-03-20T10:00:00.000Z"
  }
]

Example Response — Project Token (200 OK):

[
  {
    "id": "68db4aa2967d9c03fa9b5e74",
    "name": "Invoice Processing",
    "description": "Automated invoice extraction pipeline",
    "organizationId": "68da2880b45d7a01d90a3c51",
    "isActive": true,
    "createdAt": "2026-01-10T09:00:00.000Z",
    "updatedAt": "2026-03-15T16:45:00.000Z"
  }
]

Common Errors:

StatusCause
401Token is invalid or missing