Get organization settings

GET

/Organization/settings/:orgId

GET

/api/Organization/settings/:orgId

$ curl https://api-sandbox.payabli.com/api/Organization/settings/123 \
>      -H "requestToken: <apiKey>"

1 {
2   "customFields": [
3     {
4       "key": "key",
5       "readOnly": false,
6       "value": "value"
7     }
8   ],
9   "forInvoices": [
10     {
11       "key": "key",
12       "readOnly": false,
13       "value": "value"
14     }
15   ],
16   "forPayOuts": [
17     {
18       "key": "key",
19       "readOnly": false,
20       "value": "value"
21     }
22   ],
23   "forWallets": [
24     {
25       "key": "key",
26       "readOnly": false,
27       "value": "value"
28     }
29   ],
30   "general": [
31     {
32       "key": "key",
33       "readOnly": false,
34       "value": "value"
35     }
36   ],
37   "identifiers": [
38     {
39       "key": "key",
40       "readOnly": false,
41       "value": "value"
42     }
43   ]
44 }

Retrieves an organization's settings.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

orgIdintegerRequired

The numeric identifier for organization, assigned by Payabli.

Response

Success

customFieldslist of objectsOptional

Any custom fields defined for the org.

forInvoiceslist of objectsOptional

forPayOutslist of objectsOptional

forWalletslist of objectsOptional

Information about digital wallet settings for the entity.

generallist of objectsOptional

identifierslist of objectsOptional

Errors

400

Bad Request Error

400

Bad Request Error

401

Unauthorized Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error