Skip to main content
GET
Get record and aliases for a given instrumentId.

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

instrumentId
string<uuid>
required

Identifier of the resource in Payrails.

Query Parameters

includeVolatileInfo
boolean
default:false

Boolean indicating if additional information regarding volatile fields should be included in the response.

Response

200 - application/json

Successful retrieval of records and aliases by instrumentId.

instrumentId
string<uuid>
records
object[]
Last modified on October 7, 2026