List Option Grants

get

https://mock-api.carta.com/v1alpha1/issuers/{issuerId}/optionGrants

Scope(s): read_issuer_securities OR readwrite_issuer_securities

Retrieve option grants.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

issuerId

string

required

The identifier of the issuer that issued the option grants to retrieve.

Query Params

pageSize

int32

The maximum number of option grants to return. The service may return fewer than this value.

If unspecified, at most 25 funds will be returned.

The maximum value is 50; values above 50 will be coerced to 50.

pageToken

string

A page token received as nextPageToken in a previous List Option Grants response. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to optionGrants must match the call that provided the page token.

lastModifiedDatetimeAfter

string

Return option grants that were last modified on or after this date and time. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'.

lastModifiedDatetimeBefore

string

Return option grants that were last modified on or before this date and time. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'.

Responses

200A successful response.

400Returned if required fields are omitted or if provided fields fail validation.

401Returned if a valid Authorization header has not been included with the request.

403Returned when the user does not have permission to access the resource.

500Returned if an unexpected internal server error is encountered.

defaultAn unexpected error response.