API Reference
Status PageAUDD DigitalAUDD Digital Knowledge BaseSubmit a Ticket

Get list of companies

get
https://api.sandbox.audd.digital/companies

Returns the companies visible to you. An ordinary integration is scoped to its own company, so this returns exactly one entry, which is a convenient way to look up your own companyId for POST /bank-accounts and POST /wallets/external.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Zero-based index of the page to return.

string

Sort direction. Any other value is rejected.

string

Free-text search, case-insensitive and matching anywhere in the value. Covers the company name, email, phone number and ID. An empty value matches everything.

string

Number of items returned per page. A value below 1 is rejected with a 500.

string

Attribute to sort by, given as the underlying record's field name, for example dateCreated or name. An unrecognised field is rejected with a 500.

Headers
string
required

Bearer JWT obtained from POST /mfa/login. Send as "Bearer ". Expires after 5 minutes.

Responses

401

Unauthorized

404

Not found

500

Internal server error

Updated about 2 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?