Skip to main content
GET
/
organizations
/
my
Get My Organization
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/organizations/my \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Organization Name",
    "type": 1,
    "activatedAt": "2024-12-01T12:34:56.000Z",
    "engagementDuration": 12,
    "engagementEndAt": "2024-12-01T12:34:56.000Z",
    "siteIds": [
      1,
      2,
      3
    ],
    "updatableFields": {
      "name": true,
      "type": true,
      "engagementDuration": true,
      "uploadSizeLimit": true,
      "billedEstablishmentCount": true,
      "language": true,
      "timezone": true,
      "comment": true,
      "activatedAt": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "all-sites-ids": Get all the site ids in the organization

  • "updatable-fields": Get information about the field that can be updated

  • "actions-info": Give information about actions that can be done on the organization

Available options:
all-sites-ids,
updatable-fields,
actions-info

Response

200 - application/json

Get the organization information

​
data
object
required