STstarkbank
Corporate Holder

List Corporate Holders

Get a list of corporate holders in chunks of at most 100. If you need smaller chunks, use the limit parameter.

get/v2/corporate-holder

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/corporate-holder
  • Auth
    API key in header Digital-Signature

Query parameters

afterstring date

Filter entities created after this date.

beforestring date

Filter entities created before this date.

cursorstring

String used to get the next batch of results. Our SDKs handle this for you.

expandstring

Fields to return expanded in the response. Options: "rules", "centerName".

fieldsstring[]

List of strings to filter response JSON keys. Not available in the SDKs.

idsstring[]

List of up to 100 strings to get specific entities by ids.

limitinteger

Number of results per cursor. Max = 100.

namesstring[]

List of up to 100 exact holder names to filter retrieved entities. Not available in the SDKs.

searchstring

String used to search holders by name. When it is informed, no cursor is returned. Not available in the SDKs.

statusstring

Filter holders by the specified status. Options: "active", "blocked", "canceled".

tagsstring[]

Filter entities that contain the specified tags.

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.