Skip to main content
GET
/
organizations
/
v2
/
bo
List organizations
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/organizations/v2/bo \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "type": 2,
      "name": "Organization Name",
      "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",
      "onboardingStatus": 2,
      "onboardingUpdatedAt": "2024-12-01T12:34:56.000Z",
      "createdByUserId": 1,
      "contractType": 1,
      "accessStatus": 2,
      "accessStatusUpdatedAt": "2024-12-01T12:34:56.000Z",
      "address": "123 Main St, City, Country",
      "archivedAt": "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",
      "userCount": 10,
      "presignedUrl": "https://example.com/presigned-url",
      "establishmentCount": 5,
      "createdByUser": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "email": "test@mail.com"
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

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:

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

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

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

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

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

Available options:
user-count,
logo,
establishment-count,
created-by,
actions-info
​
whereText
string

Filter by text in multiple fields

Example:

"string"

​
whereType
integer[]

Filter by organization type

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereName
string

Filter by name

Example:

"string"

​
whereComment
string

Filter by comment

Example:

"string"

​
whereEngagementDuration
integer[]

Filter by engagement duration

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereUploadSizeLimit
integer[]

Filter by upload size limit

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereUploadSizeUsed
integer[]

Filter by upload size used

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereLanguage
integer[]

Filter by language

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereTimezone
string

Filter by timezone

Example:

"string"

​
whereEngagementEndAt
object

Filter by engagement end at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereEngagementStartAt
object

Filter by engagement start at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereRenewAt
object

Filter by renew at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereContractType
integer[]

Filter by contract type

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereDeletedAt
boolean

Filter by deletedAt

Example:

true

​
whereOnboardingStatus
integer[]

Filter by onboarding status

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereOnboardingUpdatedAt
object

Filter by onboarding updated at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereAccessStatus
integer[]

Filter by access status

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereAccessStatusUpdatedAt
object

Filter by access status updated at

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereCreatedByUserId
integer

Filter by createdByUserId

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

1

​
whereCreatedByUserName
string

Filter by createdByUser name

Example:

"string"

​
whereAddress
string

Filter by address

Example:

"string"

​
whereIsDeleted
boolean

Filter by deletedAt

Example:

true

​
whereIsArchived
boolean

Filter by archivedAt

Example:

true

​
whereUpdatedAt
object

Filter by updatedAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereCreatedAt
object

Filter by createdAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

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

1

​
pageSize
integer
default:50

Page size.

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

50

​
findId
integer

Get the page where the item with this id is located.

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

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

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

10

Response

200 - application/json

List of organizations

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.