Skip to main content
GET
List your investors

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL (the host root, not under the base URL), with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed. The token identifies your partner account, so you never send a partner id, and every record you create is scoped to you.

Query Parameters

externalInvestorId
string[]

Exact match on your own id. Repeat for several values.

Your own identifier. Letters, digits, ., _ and -; 1 to 128 characters.

Pattern: ^[A-Za-z0-9._-]{1,128}$
email
string<email>[]

Exact match on the email sent at create, case-insensitive. Repeat for several values.

limit
integer
default:20

Rows per page, 1 to 20.

Required range: 1 <= x <= 20
offset
integer
default:0

Rows to skip, 0 to 10 000.

Required range: 0 <= x <= 10000

Response

A page of investors, newest first.

A page of investors.

meta
object
required

Paging information.

data
object[]
required

The investors in this page, newest first.