v3

latestSwagger 2.02026-08-067506752.0 MB

stockgrant

Retrieve stock grants

get/v1/org/{orgId}/stockgrant

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

personIdstring

Person id to filter by

fromDatestring date

From date, inclusive

untilDatestring date

Until date, exclusive

fromstring

Stock grant id to start paginating from

limitinteger

Number of results to return

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "personId": "588f7ee98f138b19220041a7",
      "externalId": "588f7ee98f138b19220041a7",
      "stock": "GOOG",
      "createId": "588f7ee98f138b19220041a7",
      "createAt": "2017-01-24T13:57:52Z",
      "updateAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteAt": "2017-01-24T13:57:52Z"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}