Identities

Retrieve an identity

Changed on

Retrieves detailed information about a specific identity using their identity ID or external ID from your system.

get/v2/identities/{id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/identities/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Identity ID to retrieve.

Query parameters

include_metricsboolean

Include aggregate usage metrics on the returned identity.

include_budgetboolean

When true, embed the identity-scoped budget (config and limits only, no live usage) on the returned record.

Response

OK

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value from the //////////// response property for the response status

    • info

      removed the BUDGET_PERIOD_UNSPECIFIED enum value from the /////////// response property for the response status

    • warning

      added the new BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value to the //////////// response property for the response status

    • warning

      added the new BUDGET_PERIOD_UNSPECIFIED enum value to the /////////// response property for the response status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status