Skip to content

Get your Organisation

GET
/organisation

Get details of your Organisation including all users

Authorizations

Responses

200

Success message

object
organisations
Array<object>
object
name

Name of organisation

string
apiKey

Api key

string
taxLiable

Is tax Liable

string
addr1

Address line 1

string
addr2

Address line 2

string
city

City

string
country

Country

string
postcode

Postcode

string
callbackUrl

Callback url

string
notes

Notes attached to organisation

string
groups

Groups an organisation is assigned to

Array<string>
currency

Current selected currency

string
balance

Organisational balance

integer
businessType

Business Type

string
website

Website

string
productDescription

Product Description

string
users
Array<object>
object
firstName

First Name

string
lastName

Last Name

string
role

User Role

string
emailAddress

Email Address (login)

string
phoneNumber

Phone Number

string
timeZone

User Time Zone

string

400

Bad Request - returned when request format is not accepted

object
message

Status of api functions which do not return data

string

403

Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user

object
message

Status of api functions which do not return data

string

500

Server Error

object
message

Status of api functions which do not return data

string