Page shareholder files

GET

https://api.t-dx.com/api/rest/v1/issuers/:issuerId/shareholder-files

GET

/api/rest/v1/issuers/:issuerId/shareholder-files

curl https://api.t-dx.com/api/rest/v1/issuers/issuerId/shareholder-files \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "string",
      "instrumentId": "string",
      "error": "string",
      "importedAt": "2024-01-15T09:30:00Z",
      "processedAt": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "status": "STATUS_CREATED"
    }
  ],
  "pagination": {
    "cursors": {
      "self": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "first": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "last": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "next": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "previous": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ=="
    }
  },
  "sortingKeys": [
    {
      "key": "created_at-asc",
      "dir": "asc",
      "label": "key.deposits.sorts.created_at-asc",
      "fieldKey": "created_at"
    }
  ],
  "filters": [
    {
      "key": "instrument_id",
      "label": "key.deposits.filters.instrument_id",
      "range": {
        "min": "1",
        "max": "5000"
      },
      "values": [
        {
          "key": "STATUS_NEW",
          "label": "key.deposits.filters.status.fields.new"
        }
      ],
      "filterType": "FILTER_TYPE_VALUES",
      "valueType": "VALUE_TYPE_STRING"
    }
  ],
  "query": [
    "string"
  ]
}

This endpoint lists the existing shareholder files. Results can be limited to a single instrument.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

issuerIdstringRequired

Query parameters

sortstringOptional

limitstringOptionalformat: "uint64"

querylist of stringsOptional

cursorstringOptional

fieldslist of stringsOptional

Response

A successful response.

resultlist of objectsOptional

paginationobjectOptional

sortingKeyslist of objectsOptional

filterslist of objectsOptional

querylist of stringsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error