Skip to content

Get Current Organisation Details

GET
/organisation

Get details of your Organisation including all users

Authorizations

Responses

200

OK

object
Example
{
"organisations": [
{
"name": "<string>",
"apiKey": "<string>",
"taxLiable": "<string>",
"addr1": "<string>",
"addr2": "<string>",
"city": "<string>",
"country": "<string>",
"postcode": "<string>",
"callbackUrl": "<string>",
"notes": "<string>",
"groups": [
"<string>",
"<string>"
],
"currency": "<string>",
"balance": "<integer>",
"testCredit": "<integer>",
"testCreditExpiry": "<string>",
"businessType": "<string>",
"website": "<string>",
"productDescription": "<string>",
"users": [
{
"firstName": "<string>",
"lastName": "<string>",
"role": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"timeZone": "<string>"
},
{
"firstName": "<string>",
"lastName": "<string>",
"role": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"timeZone": "<string>"
}
]
},
{
"name": "<string>",
"apiKey": "<string>",
"taxLiable": "<string>",
"addr1": "<string>",
"addr2": "<string>",
"city": "<string>",
"country": "<string>",
"postcode": "<string>",
"callbackUrl": "<string>",
"notes": "<string>",
"groups": [
"<string>",
"<string>"
],
"currency": "<string>",
"balance": "<integer>",
"testCredit": "<integer>",
"testCreditExpiry": "<string>",
"businessType": "<string>",
"website": "<string>",
"productDescription": "<string>",
"users": [
{
"firstName": "<string>",
"lastName": "<string>",
"role": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"timeZone": "<string>"
},
{
"firstName": "<string>",
"lastName": "<string>",
"role": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"timeZone": "<string>"
}
]
}
]
}

400

Bad Request

object
Example
{
"message": "<string>"
}

403

Forbidden

object
Example
{
"message": "<string>"
}

500

Internal Server Error

object
Example
{
"message": "<string>"
}