API Reference

Get organization

get
https://stage-api.findity.com/api/v1/admin/organizations/

Returns a single organization by its internal ID or externalSourceId. Pass the organization's externalSourceId as the {organizationId} path parameter and the API resolves it to the correct organization. Returns 404 when the organization does not exist or the authenticated user is not an administrator of it.

Path Params
string
required

String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.

Query Params
string

String. Comma-separated list of optional data sections to include in the response. Accepted values: address, invoiceDetails, settings, design, partner. Sections not listed here are omitted from the response.

Responses

Updated 23 days ago

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

Updated 23 days ago

Did this page help you?