Skip to main content
GET
/
organizations
/
bo
/
new
List anomalies for the given site Ids
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/organizations/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"
      },
      "deactivatedBy": {
        "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
      }
    }
  ],
  "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"

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
​
x-sites
string

List of site IDs.

Example:

"['1', '2']"

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)

  • "deactivated-by": Get information about the deactivated 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

Available options:
establishment-count,
member-count,
created-by,
onboarded-by,
deactivated-by,
reseller,
actions-info
​
whereName
string

Filter by name

Example:

"string"

​
whereText
string

Filter by text in multiple fields

Example:

"string"

​
whereStatus
integer[]

Filter by status

Example:
[1, 2, 3]
​
whereType
integer[]

Filter by type

Example:
[1, 2, 3]
​
whereEngagementDuration
integer[]

Filter by engagement duration

Example:
[1, 2, 3]
​
whereUploadSizeLimit
integer[]

Filter by upload size limit

Example:
[1, 2, 3]
​
whereUploadSizeUsed
integer[]

Filter by upload size used

Example:
[1, 2, 3]
​
whereBilledEstablishmentCount
integer[]

Filter by billed establishment count

Example:
[1, 2, 3]
​
whereComment
string

Filter by comment

Example:

"string"

​
whereResellerId
integer[]

Filter by reseller

Example:
[1, 2, 3]
​
whereOnboardedById
integer[]

Filter by onboarded by

Example:
[1, 2, 3]
​
whereCreatedById
integer[]

Filter by created by

Example:
[1, 2, 3]
​
whereDeactivatedById
integer[]

Filter by deactivated by

Example:
[1, 2, 3]
​
whereEngagementEndAt
object

Filter by engagement end at

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

Filter by deactivated at

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

Filter by activated at

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

Filter by onboarded at

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

Filter by deletedAt

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.

Example:

1

​
pageSize
integer
default:50

Page size.

Example:

50

​
findId
integer

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

Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Example:

10

Response

200 - application/json

List of anomalies

​
data
object[]
required
​
totalCount
integer

Total count of items.

Example:

100

​
pagination
object

Pagination information.