Data

List all notifications for your account

get
/data/notifications
Authorizations
DOCK-API-TOKENstringRequired
Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
readbooleanOptional

Whether to return read/unread items, or all if not provided

Responses
200

A paged array of notifications

application/json
get
/data/notifications

Gets your user profile

get
/data/profile
Authorizations
DOCK-API-TOKENstringRequired
Responses
200

Your user profile

application/json
get
/data/profile

Updates your user profile metadata

patch
/data/profile
Authorizations
DOCK-API-TOKENstringRequired
Body
namestringRequired
imagestringRequired
Responses
200

User profile has been updated

No content

patch
/data/profile

No content

Marks all pending notifications as read

post
/data/notifications/mark-read
Authorizations
DOCK-API-TOKENstringRequired
Responses
200

Latest notifications have been marked as read

No content

post
/data/notifications/mark-read

No content

Certs internal route, not for typical usage. Submits onboarding information for new accounts.

post
/data/onboarding
Authorizations
CERTS-TOKENstringRequired
Body
objectOptional
Responses
200

Success

application/json
Responseobject
post
/data/onboarding
get
/data/limits

Gets the plan limits for your account

Authorizations
DOCK-API-TOKENstringRequired
Responses
200

Account paid plan limits

application/json
get
/data/limits
get
/data/history

Gets the call history for your account

Authorizations
DOCK-API-TOKENstringRequired
Responses
200

Account paid calls history by date

application/json
Responseobject[]

Default response

get
/data/history
get
/data/transactions

Gets the transactions for your account

Authorizations
DOCK-API-TOKENstringRequired
Query parameters
offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0
limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64
Responses
200

Account transactions

application/json
get
/data/transactions
get
/data/stats

Gets some statistics for your account

Authorizations
DOCK-API-TOKENstringRequired
Responses
200

Account statistics

application/json
get
/data/stats
post
/data/delete

Deletes all data stored on our servers (credentials, dids, profiles, etc - not authentication/account data).

Authorizations
DOCK-API-TOKENstringRequired
Body
validationstringOptional
Responses
200

Data has been deleted

application/json
post
/data/delete
post
/data/accountdelete

WARNING - Deletes your entire account! this is a two step process that requires getting a token then re-submitting that token as validation

Authorizations
DOCK-API-TOKENstringRequired
Body
reasonstringOptional
validationstringOptional
Responses
200

Account has been deleted

application/json
post
/data/accountdelete

Last updated

Was this helpful?