Skip to main content
GET
/
organizations
/
v2
/
bo
/
{organizationId}
Get Organization by Id
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/organizations/v2/bo/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Organization Name",
    "type": 2,
    "comment": "Comment",
    "uploadSizeLimit": 5120,
    "uploadSizeUsed": 0,
    "language": 1,
    "timezone": "Europe/Paris",
    "engagementDuration": 12,
    "engagementEndAt": "2024-12-01T12:34:56.000Z",
    "engagementStartAt": "2024-01-01T12:34:56.000Z",
    "renewAt": "2025-01-01T12:34:56.000Z",
    "createdByUserId": 1,
    "contractType": 1,
    "onboardingStatus": 2,
    "onboardingUpdatedAt": "2024-12-01T12:34:56.000Z",
    "accessStatus": 2,
    "accessStatusUpdatedAt": "2024-12-01T12:34:56.000Z",
    "address": "123 Main St, City, Country",
    "deletedAt": "2024-12-01T12:34:56.000Z",
    "archivedAt": "2024-12-01T12:34:56.000Z",
    "updatedAt": "2024-12-01T12:34:56.000Z",
    "createdAt": "2024-12-01T12:34:56.000Z",
    "createdByUser": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "email": "test@mail.com"
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    },
    "updatableFields": {
      "name": true,
      "comment": true,
      "uploadSizeLimit": true,
      "language": true,
      "timezone": true,
      "contractType": true,
      "engagementDuration": true,
      "engagementStartAt": true,
      "onboardingStatus": true,
      "accessStatus": true,
      "address": true
    },
    "presignedUrl": "https://example.com/presigned-url",
    "establishmentCount": 5,
    "userCount": 10
  }
}

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"

Path Parameters

​
organizationId
integer
required

Unique identifier of the organization.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "created-by": Get information about the creator of the organization

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

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

  • "logo": Add the presigned URL for the Organization logo

  • "establishment-count": Get information about the establishment count in the organization (Rights: Akord, Distributor, Reseller)

  • "user-count": Get information about the user count in the organization (Rights: Akord, Distributor, Reseller)

Available options:
created-by,
actions-info,
updatable-fields,
logo,
establishment-count,
user-count

Response

200 - application/json

Get the organization information

​
data
object
required