Skip to main content
GET
/
organizations
/
{organizationId}
/
bo
/
new
Get Organization by Id
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/organizations/{organizationId}/bo/new \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Organization Name",
    "status": 4,
    "processSave": {
      "page": 3,
      "process": 1,
      "establishmentId": 24
    },
    "type": 1,
    "engagementDuration": 12,
    "language": 1,
    "timezone": "Europe/Paris",
    "billedEstablishmentCount": 5,
    "engagementEndAt": "2024-12-01T12:34:56.000Z",
    "deactivatedAt": "2024-12-01T12:34:56.000Z",
    "activatedAt": "2024-12-01T12:34:56.000Z",
    "onboardedAt": "2024-12-01T12:34:56.000Z",
    "deletedAt": "2024-12-01T12:34:56.000Z",
    "updatedAt": "2024-12-01T12:34:56.000Z",
    "createdAt": "2024-12-01T12:34:56.000Z",
    "uploadSizeLimit": 5120,
    "uploadSizeUsed": 0,
    "comment": "Comment",
    "resellerId": 1,
    "onboardedById": 1,
    "establishmentCount": 5,
    "memberCount": 5,
    "createdBy": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]"
    },
    "onboardedBy": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe"
    },
    "reseller": {
      "id": 1,
      "name": "Reseller Name"
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true,
      "canBeRestored": true,
      "canSetAccess": true,
      "canSaveProcess": true,
      "canRequestOnboarding": true,
      "canOnboard": true
    },
    "updatableFields": {
      "name": true,
      "type": true,
      "engagementDuration": true,
      "uploadSizeLimit": true,
      "billedEstablishmentCount": true,
      "language": true,
      "timezone": true,
      "comment": true,
      "activatedAt": true
    },
    "deactivatedBy": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}

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"

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json

Path Parameters

​
organizationId
integer
required

Unique identifier of the organization.

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

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

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

  • "created-by": Get information about the creator of the organization (Rights: Akord, Distributor, Reseller)

  • "onboarded-by": Get information about the onboarded of the organization (Rights: Akord)

  • "reseller": Get information about the reseller of the organization (Rights: Akord, Distributor)

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

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

  • "deactivated-by": Get information about the deactivated of the organization (Rights: Akord)

Available options:
establishment-count,
member-count,
created-by,
onboarded-by,
reseller,
actions-info,
updatable-fields,
deactivated-by

Response

200 - application/json

Get the organization information

​
data
object
required