Full List of API Errors
You can use these tables as a reference when integrating against our API Error entities.
Supporting information can be found in additional error fields as described by the error schema.
Authentication and Gateway errors​
Errors of this type have five-digit codes.
| Code | Name | Description |
|---|---|---|
| 40101 | AuthorizationHeaderEmpty | The Authorization header is required for authentication. It should contain a valid API Token generated from the Orgvue tokens dashboard. It should follow the Bearer authentication scheme, i.e. be of the format Bearer: {apiToken}. |
| 40102 | ApiTokenInvalid | The API Token in the Authorization header was not valid. API Tokens must be exactly of the format generated by the Orgvue tokens dashboard. |
| 40103 | BearerTokenNotFound | The Authorization header must follow the Bearer authentication scheme, i.e. be of the format Bearer: apiToken. |
| 40301 | ApiTokenNotYetActive | The API Token was used before its Start Date. The Start Date is set when generating a token via the Orgvue tokens dashboard. |
| 40302 | ApiTokenExpired | The API Token was used after its Expiration Date. The Expiration Date is set when generating a token via the Orgvue tokens dashboard. |
| 40303 | ApiTokenSubnetViolation | The API Token could not be used from your IP address. The permitted IP Subnets are set via the Orgvue tokens dashboard (which also display your current IP address). |
| 40321 | MultipleAccountsFound | Multiple accounts were found for your user. You should contact support@orgvue.com to resolve this issue. |
| 40322 | UserAccountDisabled | The API Token is not valid because the associated user account is disabled. A different API Token must be used that was generated for an active account. |
| 40323 | UserAccountExpired | The API Token is not valid because the associated user account has expired. A different API Token must be used that was generated for an active account. |
| 40324 | UserAccountSubnetViolation | The user account associated with the API Token could not be accessed from your IP address. This is due to IP restrictions set for this user. |
| 40325 | UserApiTokenAccessProhibited | The user account associated with the API Token has not been granted API Token access. An administrator needs to allow access for this user. |
| 40342 | TenantSubnetViolation | The requested tenant cannot be accessed from your IP address. Tenant IP restrictions can be updated by an administrator via the Super UI portal. |
| 40343 | TenantExpired | The requested tenant cannot be accessed as it has expired. You should contact support@orgvue.com to resolve this issue. |
| 40344 | TenantApiTokenAccessProhibited | API Token access is prohibited for this tenant. Tenant API Token access can be updated by an administrator via the Super UI portal. |
| 40345 | TenantUsagePlanNotConfigured | The API Usage Plan for this tenant is not configured. Please contact support@orgvue.com to resolve this issue. |
| 40401 | TenantOrUserAccountNotFound | The tenant or user account could not be found. You should contact support@orgvue.com to resolve this issue. |
| 40901 | TransactionConflictRetryLater | Another transaction involving this dataset is currently in progress. Please attempt the transaction again at a later time. |
Usage plan errors​
| Code | Name | Description |
|---|---|---|
| 42901 | Throttled | The limit for the number of API requests that can be made within a certain time period has been exceeded. You may try again later. If the issue persists you should contact support@orgvue.com. |
| 42902 | QuotaExceeded | The limit for the number of API requests has been exceeded. You should contact support@orgvue.com to resolve this issue. |
Gateway errors​
| Code | Name | Description |
|---|---|---|
| 50001 | InternalServerError | There was an internal error. If the issue persists you should contact support@orgvue.com. |
| 50201 | BadGatewayError | There was an unexpected error. If the issue persists you should contact support@orgvue.com. |
| 50301 | ServiceUnavailable | Our service is currently offline, please try again later. If the issue persists you should contact support@orgvue.com. |
| 50401 | GatewayTimeout | There was an unexpected error. If the issue persists you should contact support@orgvue.com. |
| 50402 | GatewayIntegrationError | There was an unexpected error. If the issue persists you should contact support@orgvue.com. |
Orgvue-specific permissioning/internal errors​
| Code | Name | Description |
|---|---|---|
| 40360 | DatasetActionForbidden | You do not have permission to access the dataset specified by the dataset id. |
| 40361 | ItemReadForbidden | You do not have permission to access the item with the given unique identifier in this dataset. |
| 40362 | IdentityKeyReadDenied | You do not have permission to access the item property that was specified as the identity key. |
| 40363 | ItemDeleteDenied | You do not have permission to delete the item with the given unique identifier in this dataset. |
| 40364 | MergeKeyReadDenied | You do not have permission to access the item property that was specified as the merge key. |
| 40365 | ItemModificationForbidden | No access rights available to Create, Update or Delete any Items |
| 40367 | WebhookActionForbidden | You do not have permission to perform this action on the webhook provided. |
| 42201 | SecurityRuleIsInvalid | Custom permissioning rules are written in an internal file, and this error arises if that file is found written in a way that ends up invalid. |
| 42202 | DatasetIsMissingAutoId | The dataset specified by the given dataset id does not have any property set as the autoId. |
Bad request errors​
Errors of this type have six-digit codes.
| Code | Name | Description |
|---|---|---|
| 400000 | RequestIsInvalid | This is the default error response for all 4XX errors. If you are seeing this error, one or more of the following has gone wrong: The requested resource was not found. The payload contains an unsupported media type. The request was too large to process. The request was blocked by AWS WAF or was otherwise denied. If the issue persists you should contact support@orgvue.com. |
| 400001 | JsonPayloadMustNotBeEmpty | The body of the request was unexpectedly empty. |
| 400002 | JsonPayloadIsInvalid | The body of the request was not valid JSON. |
| 400003 | JsonPayloadMustBeObject | The JSON body of the request was not an object. An object was expected matching the schema described in our OpenAPI documentation. |
| 400004 | JsonBodyIsNotAllowed | This HTTP method must not include a JSON payload. |
| 400006 | QueryParameterKeyIsInvalid | A key in the query string was not a valid JSON path. |
| 400007 | FieldMustNotBeSetViaQueryParameter | The field specified by a query parameter is not allowed to be set in the query string. It should instead be set via the JSON body. |
| 400008 | QueryParameterKeyNotImplemented | A key in the query string must be one of a particular set of allowed values. The specific key will be indicated by queryParameterKey |
| 400011 | FieldMustNotBeEmpty | A field in the payload is required. The specific field will be indicated by the jsonBody or queryParameter. |
| 400012 | FieldMustNotBeNull | A field in the payload must not be null. The specific field will be indicated by the jsonBody or queryParameter. |
| 400013 | FieldMustBeProvided | You must provide this mandatory field with this request. |
| 400014 | FieldValueNotAllowed | The value provided for the field indicated is not allowed (allowed values may depend on other parameters provided). |
| 400016 | FieldIsReserved | This is a reserved property where the value cannot be edited. |
| 400017 | FieldKeyNotAllowed | The provided property key must be in an acceptable format (e.g. should not prefixed with _). |
| 400018 | FieldMustBeSpecificValue | The value provided for the field indicated can only be one specific value. This should conform to the expected schema. |
| 400020 | FieldMustNotBeMultivalued | A value for a key in the query string must be singular. The specific key will be indicated by queryParameterKey |
| 400101 | FieldMustBeString | A field in the payload must be a string. The specific field will be indicated by the jsonBody or queryParameter. |
| 400102 | FieldMustMatchRegex | A field in the payload must be a string matching a format defined by a regular expression. The specific field will be indicated by the jsonBody or queryParameter. |
| 400103 | FieldMustBeUUIDString | A field in the payload must be a string matching the UUID format. The specific field will be indicated by the jsonBody or queryParameter. |
| 400104 | FieldMustBeTenantIdString | A field in the payload must be a string matching the expected format for a tenant id. This is a string of 1 to 30 characters from a-z, A-Z, 0-9 and _. The specific field will be indicated by the jsonBody or queryParameter. |
| 400105 | FieldMustBeSecureURLString | The export object location you have provided is not a https uri. |
| 400107 | PortMustNotBeSpecified | Must not specify ports when providing secure uri locations for export. |
| 400121 | FieldMustBeEnumMember | A field in the payload must be one of a particular set of allowed values. The specific field will be indicated by the jsonBody or queryParameter. |
| 400122 | TemplateVariableMustBeEnumMember | A variable in the url template must be one of a particular set of allowed values: jobStatus, traceId,tenantId |
| 400201 | FieldMustBeNumber | A field in the payload must be a number. The specific field will be indicated by the jsonBody or queryParameter. |
| 400291 | FieldMustBeBoolean | A field in the payload must be either true or false. The specific field will be indicated by the jsonBody or queryParameter. |
| 400301 | FieldMustBeObject | A field in the payload must be an object. The specific field will be indicated by the jsonBody or queryParameter. |
| 400302 | ObjectMustNotBeEmpty | The object field provided must not be empty. |
| 400306 | FilterOperatorNotSupported | A key under a filter object prefixed with a dollar sign ($) must be a supported MongoDB operator ($in,$nin, $lt,$lte, $gt,$lte, $notor$or). |
| 400351 | FieldMustBeArray | A field in the payload must be an array. The specific field will be indicated by the jsonBody or queryParameter. |
| 400352 | ArrayMustNotBeEmpty | The array field provided must not be empty. |
| 400353 | ArrayMustNotContainDuplicates | The array field provided must not contain duplicate entries. |
| 400511 | PathParameterMustNotBeEmpty | A path parameter must not be empty. The specific path parameter will be indicated the pathParameter. |
| 400602 | PathParameterMustMatchRegex | A path parameter must be a string matching a format defined by a regular expression. The specific path parameter will be indicated the pathParameter. |
| 400603 | PathParameterMustBeUUIDString | A path parameter must be a string matching the UUID format. The specific path parameter will be indicated the pathParameter. |
| 400604 | PathParameterMustBeTenantIdString | A path parameter must be a string matching the expected format for a tenant id. This is a string of 1 to 30 characters from a-z, A-Z, 0-9 and _. The specific path parameter will be indicated the pathParameter. |
| 400621 | PathParameterMustBeEnumMember | A path parameter must be one of a particular set of allowed values. The specific path parameter will be indicated the pathParameter. |
| 400622 | PathParameterMustBeExportFormat | A path parameter must be an export format, i.e. it must be "JsonRows" (other formats will be available in future versions). The specific path parameter will be indicated the pathParameter. |
| 400651 | PropertyMustBeOnDemand | The on-demand evaluation property you have specified is not an on-demand property. |
| 400660 | ResourceIsExpired | The resource provided has expired. |
| 400661 | ResourceActionIsNotAllowed | A file has already been uploaded to the resource location. You cannot upload to this resource again. |
| 400662 | ResourceSizeIsTooLarge | The content you are trying to upload exceeds the maximum supported file size of 512MB. |
| 400663 | ResourceIsEmpty | The resource you are trying to use is empty or has not been uploaded. |
| 400666 | IncorrectContentTypeProvided | Incorrect content-type header provided. |
| 400799 | PropertyMustBeAutoId | The property key you have specified is not the autoId. |
| 400800 | IdentityKeyMustBeIndexed | The property key you have specified is not indexed. |
| 400801 | ItemAlreadyExists | An item with this unique identifier already exists. You cannot create an item with the same unique identifier. |
| 400802 | ActionIsNotAllowed | You cannot perform this action in this context. |
| 400803 | ActionIsForbidden | You do not have permission to perform this action. |
| 400804 | ItemNotFound | The item specified by the identifier key was not found. |
| 400805 | ItemIdMustBeProvided | The item object in the request payload does not have the identifier field/key included. |
| 400806 | ItemActionMustBeUnique | A specific item has more than one action object in the request payload. |
| 400807 | ItemPropertyUpdateForbidden | You do not have permission to update this item. |
| 400808 | ItemMatchMustBeUnique | The supplied identifier key matches more than one item (doesn't apply for _id). |
| 400809 | MergeKeyMustBeProvided | The merge key specified in the query parameter isn't provided in the request payload. |
| 400810 | IdKeyMustBeProvided | The idKey key specified in the query parameter isn't provided in the request payload. |
| 400811 | LinksDatasetNotSupported | The dataset modification endpoint does not support datasets of type "LINKS". Please utilize the appropriate endpoint specifically designed for link datasets when making modifications. |
| 400812 | PropertyMustBeRequired | This property is necessary for the correct setup of your dataset, so you must set isRequired to true |
| 400814 | LinkedDatasetsMustNotHaveSameType | Datasets of the same type cannot be linked to one another. |
| 400815 | LinkedDatasetTypeMustBeEnumMember | There are restrictions on which dataset types are allowed to be linked. The dataset specified has a type that cannot be linked. Which dataset types can be linked can be configured if required. |
| 413001 | RequestTooLarge | The payload size of this request has exceeded the maximum supported size of 6Mb. |
| 404001 | ViewNotFound | The view specified by the given view id was not found on the server. Please check that it exactly matches the value for your desired view. |
| 404002 | DatasetNotFound | The dataset specified by the given dataset id was not found on the server. Please check that it exactly matches the value for your desired dataset. |
| 404003 | ViewNotFoundForDataset | The dataset specified by the given dataset id exists, but no valid default view could be found. Please contact support for information on how to resolve this. |
| 404004 | LinkingDatasetNotFound | The linking dataset specified by your request could be found. Please provide a valid linking dataset id. |
| 404005 | ResourceLocationNotUsable | The resource location provided was not usable. Please check that the resource is valid, has not expired and has appropriate usage permissions. |
| 404006 | DatasetNotExpectedType | The dataset specified by the given dataset id exists, but does not match the expected type. An id for a dataset of the correct type should instead be provided. |
| 404007 | PropertyKeyNotFound | The property key you have specified does not exist. |
| 404008 | DatasetDeleted | The dataset specified by the given dataset id did exist, but is currently in the deleted state (meaning it can be restored via undelete). |
| 404009 | IdentityKeyNotFound | The property key you have specified as the identity key does not exist. |
| 404010 | MergeKeyNotFound | The property key you have specified as the merge key does not exist. |
| 404011 | LayerNotFound | The property key you have specified as the layer key does not exist. |
| 404012 | LayerConfigurationConflict | There is a configuration conflict between the layers you have provided to be folded. This is most likely because the layers you have provided have different autoIds. |
| 404013 | WebhookNotFound | The webhook specified by the given webhook id was not found on the server. Please check that it exactly matches the value for your desired webhook. |
| 405001 | HttpMethodIsNotAllowed | The http method in your request is not allowed for this path. |
| 410001 | PathHasBeenRemoved | The endpoint at the specified path is deprecated and no longer a supported API resource. The export capability by providing a viewId for the dataset is no longer supported, please use the export by datasetId endpoint instead. |
| 415001 | ContentTypeIsNotImplemented | The content type header value you provided is not implemented, please use application/json instead. |
Item Operation Errors​
The following tables are for individual Item Operation failures and will be returned for each failure.
Note that the HTTP code response will be either 400 Bad Request, or 200 OK with Failure Records depending upon the Query Parameters included with the item operation
Orgvue Item Operations allow you to create, update, or delete data records (items) within a dataset.
Each operation must identify which item or set of items it applies to, and there are three supported methods for doing so.
Understanding these identifier types helps you interpret error messages and troubleshoot issues effectively.
Item Identifier Types​
Identify by _id (internal Orgvue UUID identifier)​
This is the default method.
Items are matched by their internal _id — a unique Orgvue-generated UUID that identifies each record.
When using this method:
- The
_idmust already exist for updates or deletes. - You do not need to supply an
_idwhen creating a new record (Orgvue will generate one). - This approach guarantees a one-to-one match between the operation and the item.
Identify by unique Property Keys (Id Keys)​
This method uses one or more Property Keys that are guaranteed to be unique — for example, employeeId or autoId.
When using Id Keys:
- You can match an item using any combination of properties that together form a unique key.
- This method supports one-to-one relationships between key values and items.
- Each Id Key must exist as a property and be indexed or designated as an
autoId.
Identify by shared Property Keys (Merge Keys)​
Merge Keys are used when multiple items share the same property values — for example, all employees in the same country or region.
This method allows you to bulk update or delete items that match shared values.
When using Merge Keys:
- The key combination may match multiple items.
- Only update and delete operations are supported.
Identifier & Matching Errors​
These errors happen when Orgvue can’t find, identify, or uniquely match items based on _id, Property Keys (Id Keys), or Merge Keys.
| Code | Message | Description |
|---|---|---|
| 6293 | Item already exists | This happens when a create request uses the item’s internal Orgvue _id or a unique Property Key (Id Key), but an existing item already matches. Use createOrUpdate or createOrReplace if you want to update or replace an existing item instead. |
| 6295 | Item Operation missing _id | You’re performing an operation that identifies items by their internal Orgvue _id, but no _id value was provided. Add the _id, or switch to Property Key–based identification instead. |
| 6297 | Item not found | No item matches the _id or unique Property Key (Id Key) values you provided for update, delete, replace or noop _action. Check that your identifiers are correct and visible to your account. |
| 7290 | Multiple Item Operations found for the same Item | More than one record in your request refers to the same item. Remove duplicates so each item appears only once in your operation. |
| 7293 | Item operation must have value for all Id Keys, use null if matching on an empty value | When identifying items by unique Property Keys (Id Keys), one or more key values are missing in your request. Provide a value for each Id Key, or use null for empty values. |
| 7297 | Multiple Items found with the same Id Key(s) | When identifying items by unique Property Keys (Id Keys), more than one item was found with the same key values. Ensure your Id Keys uniquely identify a single record. When identifying items by _id, the value must be a valid Orgvue UUID (GUID). Check that each _id is properly formatted and there are no duplicate records in your dataset |
| 7299 | Item Operation must have value for all Merge Keys, use null if matching on an empty value | When identifying items by shared Property Keys (Merge Keys) for a bulk update or delete, one or more key values are missing in your request. Provide values for all Merge Keys, or use null where applicable. |
Permission & Access Errors​
These errors occur when your Orgvue account doesn’t have sufficient rights to perform the requested operation or access certain item properties.
| Code | Message | Description |
|---|---|---|
| 6296 | Item action denied | The property you are trying to access does not exist in your dataset or you don’t have permission to perform the requested create, update, or delete action on the item. Check your access rights or contact your Orgvue administrator. |
| 6298 | Item Property update denied | You don’t have permission to update one or more property values for this item. Error is also returned when applying more than one Draft to a dataset with duplicate records. Review your RBAC/ABAC permissions or contact your administrator. |
| 7201 | Item Operation predicate could not be evaluated due to Property access constraints | The update used a condition (_predicate) that references a property you can’t access or that doesn’t exist. Ensure you have read access to all properties used in the predicate. |
Action & Validation Errors​
These errors occur when the operation, its action, or configuration isn’t valid for the current context.
| Code | Message | Description |
|---|---|---|
| 6294 | Item Operation _action value not supported in this context | The specified action isn’t valid for this type of operation. For example, create actions aren’t allowed when identifying items by shared Property Keys (Merge Keys), and createOrUpdate or createOrReplace can’t be used when identifying items by _id. |
| 7298 | Value for _action is required and has not been provided | The _action field is empty in your input (often a CSV row). Add an action such as create, update, or delete for each record. |
CSV & Data Format Errors​
These errors occur when a CSV payload has structural or data formatting issues.
| Code | Message | Description |
|---|---|---|
| 7294 | _sortOrder value must be numeric | The _sortOrder value must be a number. Check that all _sortOrder values in your CSV file are numeric. |
| 7296 | CSV row has more values than specified in the header | A CSV row contains more comma-separated values than there are columns in the header. Check your CSV formatting for extra commas or missing headers. |