# Get administrations Search list of administrations based on query and params Endpoint: POST /administrations/{offset}/{amount} Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Header parameters: - `Authorization` (string, required) ## Path parameters: - `offset` (integer, required) - `amount` (string, required) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `totalResults` (integer) - `administrations` (array) - `administrations.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.uuid` (string, required) - `administrations.primaryPlatformId` (string, required) - `administrations.createdAt` (string) The date and time this Entity has been created - `administrations.updatedAt` (string) The date and time this Entity has been updated - `administrations.language` (object) circular reference - `administrations.platforms` (array) - `administrations.name` (string) - `administrations.primary` (boolean) - `administrations.transportOrderPrefix` (string) - `administrations.consignmentPrefix` (string) - `administrations.business` (object) circular reference - `administrations.currency` (object) - `administrations.currency.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.currency.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.currency.uuid` (string, required) - `administrations.currency.primaryPlatformId` (string, required) - `administrations.currency.createdAt` (string) The date and time this Entity has been created - `administrations.currency.updatedAt` (string) The date and time this Entity has been updated - `administrations.currency.language` (object) circular reference - `administrations.currency.name` (string) - `administrations.currency.short` (string) - `administrations.currency.sign` (string) - `administrations.currency.decimalDelimiter` (string) - `administrations.currency.thousandDelimiter` (string) - `administrations.currency.enabled` (boolean) - `administrations.balance` (object) - `administrations.balance.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.balance.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.balance.uuid` (string, required) - `administrations.balance.primaryPlatformId` (string, required) - `administrations.balance.createdAt` (string) The date and time this Entity has been created - `administrations.balance.updatedAt` (string) The date and time this Entity has been updated - `administrations.balance.language` (object) circular reference - `administrations.balance.amount` (number) - `administrations.balance.currency` (object) - `administrations.balance.taxRate` (object) - `administrations.balance.taxRate.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.balance.taxRate.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.balance.taxRate.createdAt` (string) The date and time this Entity has been created - `administrations.balance.taxRate.updatedAt` (string) The date and time this Entity has been updated - `administrations.balance.taxRate.creditCode` (string) - `administrations.balance.taxRate.debitCode` (string) - `administrations.balance.taxRate.identifiers` (array) - `administrations.balance.taxRate.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.balance.taxRate.identifiers.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.balance.taxRate.identifiers.createdAt` (string) The date and time this Entity has been created - `administrations.balance.taxRate.identifiers.updatedAt` (string) The date and time this Entity has been updated - `administrations.balance.taxRate.identifiers.name` (string) - `administrations.balance.taxRate.identifiers.system` (string) - `administrations.balance.taxRate.identifiers.value` (string) - `administrations.balance.taxRate.identifiers.expiredAt` (string) - `administrations.balance.taxRate.name` (string) - `administrations.balance.taxRate.description` (string) - `administrations.balance.taxRate.jurisdiction` (string) - `administrations.balance.taxRate.percentage` (number) - `administrations.balance.taxRate.inclusive` (boolean) - `administrations.balance.taxRate.active` (boolean) - `administrations.balance.inclusiveOfTax` (boolean) - `administrations.bankAccounts` (array) - `administrations.bankAccounts.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.bankAccounts.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.bankAccounts.uuid` (string, required) - `administrations.bankAccounts.primaryPlatformId` (string, required) - `administrations.bankAccounts.createdAt` (string) The date and time this Entity has been created - `administrations.bankAccounts.updatedAt` (string) The date and time this Entity has been updated - `administrations.bankAccounts.language` (object) circular reference - `administrations.bankAccounts.accountHolderName` (string) - `administrations.bankAccounts.accountHolderType` (string) - `administrations.bankAccounts.bankName` (string) - `administrations.bankAccounts.routingNumber` (string) - `administrations.bankAccounts.accountNumber` (string) - `administrations.bankAccounts.last4` (string) - `administrations.bankAccounts.currency` (object) - `administrations.bankAccounts.currency.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.bankAccounts.currency.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.bankAccounts.currency.createdAt` (string) The date and time this Entity has been created - `administrations.bankAccounts.currency.updatedAt` (string) The date and time this Entity has been updated - `administrations.bankAccounts.currency.name` (string) - `administrations.bankAccounts.currency.short` (string) - `administrations.bankAccounts.currency.sign` (string) - `administrations.bankAccounts.currency.decimalDelimiter` (string) - `administrations.bankAccounts.currency.thousandDelimiter` (string) - `administrations.bankAccounts.currency.enabled` (boolean) - `administrations.bankAccounts.country` (string) - `administrations.bankAccounts.validation` (object) circular reference - `administrations.bankAccounts.validated` (boolean) - `administrations.bankAccounts.identifiers` (array) - `administrations.bankAccounts.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.bankAccounts.identifiers.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.bankAccounts.identifiers.uuid` (string, required) - `administrations.bankAccounts.identifiers.primaryPlatformId` (string, required) - `administrations.bankAccounts.identifiers.createdAt` (string) The date and time this Entity has been created - `administrations.bankAccounts.identifiers.updatedAt` (string) The date and time this Entity has been updated - `administrations.bankAccounts.identifiers.language` (object) circular reference - `administrations.bankAccounts.identifiers.name` (string) - `administrations.bankAccounts.identifiers.system` (string) - `administrations.bankAccounts.identifiers.value` (string) - `administrations.bankAccounts.identifiers.expiredAt` (string) - `administrations.numberFormat` (string) - `administrations.numberLength` (integer) - `administrations.dueDays` (integer) - `administrations.invoiceNumberIndex` (object) - `administrations.quoteNumberIndex` (object) - `administrations.invoiceSendMessageAutomation` (object) - `administrations.invoiceSendMessageAutomation.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.invoiceSendMessageAutomation.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.invoiceSendMessageAutomation.uuid` (string, required) - `administrations.invoiceSendMessageAutomation.primaryPlatformId` (string, required) - `administrations.invoiceSendMessageAutomation.createdAt` (string) The date and time this Entity has been created - `administrations.invoiceSendMessageAutomation.updatedAt` (string) The date and time this Entity has been updated - `administrations.invoiceSendMessageAutomation.language` (object) circular reference - `administrations.invoiceSendMessageAutomation.type` (string) Enum: "messageAutomation", "questionAnswerAutomation", "fileRequestAutomation" - `administrations.invoiceSendMessageAutomation.name` (string, required) The name of a messageAutomation - `administrations.invoiceSendMessageAutomation.description` (string, required) The description of a messageAutomation - `administrations.invoiceSendMessageAutomation.automationConfig` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.triggerType` (string) Enum: "trigger", "scheduler", "listener" - `administrations.invoiceSendMessageAutomation.automationConfig.triggerEvent` (string) Enum: "afterCreatingTrip", "afterUpdatingTrip", "afterConfirmingTrip", "afterStartingTrip", "afterFinishingTrip", "afterCancelingTrip", "afterLocationUpdateEvent", "afterCreatingMessage", "afterUpdatingMessage", "afterCreatingEvent", "afterStartEngineEvent", "afterStartMovingEvent", "afterStopMovingEvent", "afterStopEngineEvent", "afterCreatingWaitAction", "afterUpdatingWaitAction", "afterCreatingWeighingAction", "afterUpdatingWeighingAction", "afterCreatingUnloadAction", "afterUpdatingUnloadAction", "afterCreatingStopAction", "afterUpdatingStopAction", "afterCreatingMoveAction", "afterUpdatingMoveAction", "afterCreatingLoadAction", "afterUpdatingLoadAction", "afterCreatingDetachTransportEquipmentAction", "afterUpdatingDetachTransportEquipmentAction", "afterCreatingDetachChauffeurAction", "afterUpdatingDetachChauffeurAction", "afterCreatingBreakAction", "afterUpdatingBreakAction", "afterCreatingAttachTransportEquipmentAction", "afterUpdatingAttachTransportEquipmentAction", "afterCreatingAttachChauffeurAction", "afterUpdatingAttachChauffeurAction", "afterActionLifeCycleUpdate", "afterCreatingCapacityContract", "afterUpdatingCapacityContract", "afterCreatingMessageAutomation", "AfterUpdatingMessageAutomation", "afterCreatingTransportOrder", "afterUpdatingTransportOrder", "afterCreatingConsignment", "afterUpdatingConsignment", "afterCreatingBusiness", "afterUpdatingBusiness", "afterCreatingInvoice", "afterSendingInvoice", "afterUpdatingInvoice", "afterCreatingQuote", "afterUpdatingQuote", "afterSendingQuote", "afterCreatingUser", "afterUpdatingUser", "afterCreatingLocation", "afterUpdatingLocation", "afterExceedingStopAverageDuration", "afterHomeBaseReturnOverdue", "afterCreatingBooking", "afterUpdatingBooking", "afterCancellingBooking", "afterConfirmingBooking", "afterCreatingIntegration", "afterUpdatingIntegration", "afterUpdatingCalendarEvent", "afterDeletingCalendarEvent", "afterCreatingTodo", "afterUpdatingTodo", "afterDeletingTodo", "afterAssigningTodo", "afterCalendarSyncRequested", "afterCalendarAuthorizationGranted" - `administrations.invoiceSendMessageAutomation.automationConfig.schedule` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleValue` (integer) - `administrations.invoiceSendMessageAutomation.automationConfig.schedule.integrationSchedulerScheduleType` (string) Enum: "seconds", "minutes", "hours", "days", "months" - `administrations.invoiceSendMessageAutomation.automationConfig.schedule.milliseconds` (integer) - `administrations.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSelector` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.uniqueIdentifierSchedule` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.filters` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.filters.selector` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.filters.comparisonType` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `administrations.invoiceSendMessageAutomation.automationConfig.filters.value` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.filters.linkType` (string) Enum: "and", "or" - `administrations.invoiceSendMessageAutomation.automationConfig.filters.filters` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.filters.sequenceNr` (integer) - `administrations.invoiceSendMessageAutomation.automationConfig.filters.valueSelector` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.query` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.query.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.invoiceSendMessageAutomation.automationConfig.query.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.invoiceSendMessageAutomation.automationConfig.query.createdAt` (string) The date and time this Entity has been created - `administrations.invoiceSendMessageAutomation.automationConfig.query.updatedAt` (string) The date and time this Entity has been updated - `administrations.invoiceSendMessageAutomation.automationConfig.query.fields` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.query.fields.name` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.query.fields.groupByAggregate` (string) Enum: "count", "max", "min", "sum", "avg" - `administrations.invoiceSendMessageAutomation.automationConfig.query.entityType` (string) Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do" - `administrations.invoiceSendMessageAutomation.automationConfig.query.joins` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.query.joins.type` (string) Enum: "inner_join" - `administrations.invoiceSendMessageAutomation.automationConfig.query.joins.entityType` (string) Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do" - `administrations.invoiceSendMessageAutomation.automationConfig.query.joins.onLeft` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.query.joins.onRight` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.createdAt` (string) The date and time this Entity has been created - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.updatedAt` (string) The date and time this Entity has been updated - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.sequenceNr` (integer) - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.field` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.comparisonOperations` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.value` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.valueType` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `administrations.invoiceSendMessageAutomation.automationConfig.query.filters.linkType` (string) Enum: "and", "or" - `administrations.invoiceSendMessageAutomation.automationConfig.query.groupBy` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.query.having` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.query.sortFields` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.query.sortDirection` (string) Enum: "asc", "desc" - `administrations.invoiceSendMessageAutomation.automationConfig.query.limit` (integer) - `administrations.invoiceSendMessageAutomation.automationConfig.query.offset` (integer) - `administrations.invoiceSendMessageAutomation.automationConfig.recipients` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.recipientSelector` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.toggleForAll` (boolean) - `administrations.invoiceSendMessageAutomation.automationConfig.channel` (string) Enum: "email", "chat", "notification", "whatsapp", "telegram" - `administrations.invoiceSendMessageAutomation.automationConfig.manualIntegration` (object) circular reference - `administrations.invoiceSendMessageAutomation.automationConfig.includeAttachments` (boolean) - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentSourceType` (string) Enum: "ENTITY_PDF", "CUSTOM_TEMPLATE", "INSIGHT_REPORT", "STATIC_FILE" - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentType` (string) Enum: "cmr", "waybill", "invoice", "quote", "transportOrder", "trip", "custom" - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.documentTemplateId` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileUrl` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.insightType` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.reportParameters` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.entityIdSelector` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.documentAttachments.fileNameTemplate` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.subject` (string) The subject of a message for a particular messageAutomation - `administrations.invoiceSendMessageAutomation.automationConfig.currentTriggerPosition` (integer) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts` (array) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language` (object) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.createdAt` (string) The date and time this Entity has been created - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.updatedAt` (string) The date and time this Entity has been updated - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.name` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.localName` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.code` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.iso3166` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.decimalDelimiter` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.thousandDelimiter` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.dateFormat` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.language.measurementUnit` (string) Enum: "metric", "imperial" - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.content` (string, required) The template of a message for a particular messageAutomation - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.messageTemplate` (string, required) The template of a message for a particular messageAutomation - `administrations.invoiceSendMessageAutomation.automationConfig.localizedTexts.subject` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.defaultLanguageId` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.languageSelector` (string) - `administrations.invoiceSendMessageAutomation.automationConfig.userEnableable` (boolean) - `administrations.invoiceSendMessageAutomation.automationConfig.userPermissionFilters` (array) - `administrations.invoiceSendMessageAutomation.messageAutomationIntegration` (object) circular reference - `administrations.invoiceSendMessageAutomation.enabled` (boolean) - `administrations.invoiceSendMessageAutomation.lastHandled` (string) - `administrations.invoiceSendMessageAutomation.template` (boolean) - `administrations.invoiceSendMessageAutomation.templateCategory` (string) - `administrations.automaticallySendReminders` (boolean) - `administrations.invoiceFirstReminderMessageAutomation` (object) - `administrations.invoiceSecondReminderMessageAutomation` (object) - `administrations.invoiceThirdReminderMessageAutomation` (object) - `administrations.invoicePaidMessageAutomation` (object) - `administrations.quoteSendMessageAutomation` (object) - `administrations.invoiceTermsAndConditions` (array) - `administrations.invoiceTermsAndConditions.language` (object) - `administrations.invoiceTermsAndConditions.text` (string) - `administrations.quoteTermsAndConditions` (array) - `administrations.transportOrderTermsAndConditions` (array) - `administrations.identifiers` (array) ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)