--- title: Events API slug: alt-data-dictionaries createdAt: 2026-02-11T16:09:52.253Z --- ### Query **Fields:** | Name | Returns | Description | | ------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `events` | [EventsResponse](docId\:Ol8F8o2lKyibFYa1HN7Wa) | Retrieves events for a given person or organization. | | `eventsBatch` | [EventsBatchResponse](docId\:Ol8F8o2lKyibFYa1HN7Wa) | Retrieves events for multiple persons or organizations in a single request. | | `info` | [InfoResponse](docId\:Ol8F8o2lKyibFYa1HN7Wa) | Returns application information and health status. | | `loadInformation` | — | Returns load information for a given batch, used for dependency checks between services. | | `eventsByType` | — | Retrieves events for future annoucements | | `eventsByTypeBatch` | — | Retrieves future announcement events for a specific batch of Altrata IDs. | ### EventsResponse **Description:** Response containing events for a single person or organization. **Fields:** | Name | Type | Description | | ------------------ | ------------------- | -------------------------------------- | | `events` | `[Event!]!` | The list of events. | | `pageInfoResponse` | `PageInfoResponse!` | Paging information for the result set. | ### Event **Description:** Represents an event associated with a person or organization. **Fields:** | Name | Type | Description | | ---------------------- | ------------------------- | ------------------------------------------------------------------------------------------------ | | `eventId` | `String!` | An enduring unique ID for the event | | `eventDate` | `String!` | The date that the event actually happened, or will happen. Deprecated in favor of eventDateInfo. | | `eventDateInfo` | `DateInformation!` | When did the event happen, or when will it happen? | | `eventType` | `String!` | What is the event type? (role start announcement, role end announcement, etc) | | `eventText` | `String!` | Main displayed text for the event | | `personMentions` | `[PersonMentions!]` | All people mentioned in the event | | `organizationMentions` | `[OrganizationMentions!]` | All organizations mentioned in the event | | `eventPublishedDate` | `AWSDate!` | What date was the event first published by Altrata? | | `announcementDate` | `String` | The announcement date. Deprecated in favor of announcementDateInfo. | | `announcementDateInfo` | `DateInformation` | If the Event is an Announcement, what was the Announcement Date? | | `startRoleTitle` | `String` | If the Event relates to a Role Start, what is the title of the role that is starting? | | `endRoleTitle` | `String` | If the Event relates to a Role End, what is the title of the role that is ending? | ### DateInformation **Description:** Represents date information with precision and display format. **Fields:** | Name | Type | Description | | --------------- | ---------------- | ------------------------------------------------ | | `date` | `AWSDate!` | The date value. | | `datePrecision` | `DatePrecision!` | The precision of the date (day, month, or year). | | `displayDate` | `String!` | A formatted display string for the date. | ### PersonMentions **Description:** Represents a person mentioned in an event. **Fields:** | Name | Type | Description | | ------------ | --------- | ---------------------------------------------- | | `personId` | `String!` | The unique identifier of the mentioned person. | | `personName` | `String!` | The name of the mentioned person. | ### OrganizationMentions **Description:** Represents an organization mentioned in an event. **Fields:** | Name | Type | Description | | ------------------ | --------- | ------------------------------------------------------------------------------------------- | | `organizationId` | `String!` | The unique identifier of the mentioned organization. | | `organizationName` | `String!` | The name of the mentioned organization. | | `organizationType` | `String` | The type of the organization (optional, as a value is not available for all organizations). | ### GenericError **Description:** Represents a generic error response. **Fields:** | Name | Type | Description | | ------------------ | ------------------- | ----------------------------------------------------------------------- | | `errorCode` | `String!` | Deprecated error code string. | | `genericErrorCode` | `GenericErrorCode!` | Displays the generic error code. | | `correlationId` | `String!` | An id used to correlate logs and metrics across services and processes. | | `errorMessage` | `String!` | A brief description of the issue that occurred. | ### Error **Description:** Base error interface for all error types. **Possible Types:** - [GenericError](docId\:Ol8F8o2lKyibFYa1HN7Wa) - [ValidationError](docId\:Ol8F8o2lKyibFYa1HN7Wa) - [AuthorizationError](docId\:Ol8F8o2lKyibFYa1HN7Wa) **Fields:** | Name | Type | Description | | --------------- | --------- | ----------------------------------------------------------------------- | | `errorCode` | `String!` | Deprecated error code string. Use typed error code instead. | | `correlationId` | `String!` | An id used to correlate logs and metrics across services and processes. | | `errorMessage` | `String!` | A brief description of the issue that occurred. | ### ValidationError **Description:** Represents a validation error response. **Fields:** | Name | Type | Description | | ------------------------ | --------------------------- | ----------------------------------------------------------------------- | | `errorCode` | `String!` | Deprecated error code string. | | `validationErrorCode` | `ValidationErrorCode!` | Displays the validation error code. | | `correlationId` | `String!` | An id used to correlate logs and metrics across services and processes. | | `errorMessage` | `String!` | A brief description of the issue that occurred. | | `errorDetails` | `[ErrorDetail!]` | Deprecated error details list. | | `validationErrorDetails` | `[ValidationErrorDetail!]!` | Displays the detailed information about the validation error. | ### ErrorDetail **Description:** Deprecated error detail type. Use ValidationErrorDetail instead. **Fields:** | Name | Type | Description | | --------- | --------- | ------------------------------------------------- | | `message` | `String!` | Displays the description of the error. | | `path` | `String` | Represents the area where the error has occurred. | | `code` | `String` | Represents the category of error. | ### AuthorizationError **Description:** Represents an authorization error response. **Fields:** | Name | Type | Description | | ------------------------ | ------------------------- | ----------------------------------------------------------------------- | | `errorCode` | `String!` | Deprecated error code string. | | `errorMessage` | `String!` | A brief description of the issue that occurred. | | `correlationId` | `String!` | An id used to correlate logs and metrics across services and processes. | | `authorizationErrorCode` | `AuthorizationErrorCode!` | Displays the authorization error code. | ### EventsFilterType **Description:** Defines the filter types for events. **Values:** | Value | Description | | --------------- | ----------- | | `ANNOUNCEMENTS` | N/A | ### EventsBatchResponse **Description:** Response containing events for multiple persons or organizations. **Fields:** | Name | Type | Description | | ------------------ | --------------------- | ----------------------------------------- | | `altrataIdEvents` | `[AltrataIdEvents!]!` | The list of events grouped by Altrata ID. | | `pageInfoResponse` | `PageInfoResponse!` | Paging information for the result set. | ### AltrataIdEvents **Description:** Represents events associated with a specific Altrata ID. **Fields:** | Name | Type | Description | | ----------- | ----------- | ------------------------------------------------ | | `altrataId` | `String!` | The Altrata ID of the person or organization. | | `events` | `[Event!]!` | The list of events for the requested Altrata ID. | ### InfoResponse **Description:** Contains application information and health status. **Fields:** | Name | Type | Description | | -------------------- | ---------- | ----------------------------------------------------------------------- | | `appVersion` | `String!` | The current version of the application. | | `environment` | `String!` | The deployment environment name. | | `deployment` | `String` | The deployment identifier. | | `healthy` | `Boolean!` | Indicates whether the application is healthy. | | `correlationId` | `String!` | An id used to correlate logs and metrics across services and processes. | | `permissionsVersion` | `String!` | The current permissions version. | | `schemaVersion` | `String!` | The current schema version. | ### LoadInformationPagedResult **Description:** Paged result for load information queries. **Fields:** | Name | Type | Description | | ------------------ | --------------------- | --------------------------------------- | | `items` | `[LoadInformation!]!` | Collection of load information records. | | `pageInfoResponse` | `PageInfoResponse!` | Pagination metadata. | ### LoadInformation **Description:** Defines the parameters or settings for loading specific information. **Fields:** | Name | Type | Description | | ----------------------- | ---------------------- | ------------------------------------------------------------------- | | `dateTimeStarted` | `DateTimeInformation!` | Represents the timestamp when the process began. | | `dateTimeCompleted` | `DateTimeInformation` | Represents the timestamp indicating when the process was completed. | | `totalRecordsProcessed` | `Int!` | Total number of records successfully processed. | | `recordsInserted` | `Int!` | Total number of records successfully inserted. | | `recordsUpdated` | `Int!` | Number of records successfully updated. | | `recordsDeleted` | `Int!` | Total number of records successfully deleted. | | `folderName` | `String!` | The S3 folder location where the data files are stored. | | `batchId` | `String` | Internal unique identifier (SQS message ID). | | `messageBatchId` | `Int` | The batch\_id passed from the SNS message. | | `batchType` | `LOAD_TYPE` | Whether the operation is a full or incremental load. | ### DateTimeInformation **Description:** Represents timestamp information for load operations. **Fields:** | Name | Type | Description | | ------ | --------- | ------------------------------------- | | `date` | `String!` | The date/time value as an ISO string. | ### LOAD\_TYPE **Description:** Indicates the type of data load operation. **Values:** | Value | Description | | ------------- | ----------- | | `full` | N/A | | `incremental` | N/A | ### EventsByTypeResult **Description:** Result type for the future events query. **Possible Types:** - [EventsByTypeResponse](docId\:Ol8F8o2lKyibFYa1HN7Wa) - [GenericError](docId\:Ol8F8o2lKyibFYa1HN7Wa) - [ValidationError](docId\:Ol8F8o2lKyibFYa1HN7Wa) - [AuthorizationError](docId\:Ol8F8o2lKyibFYa1HN7Wa) ### EventsByTypeResponse **Description:** Response containing future events for a specific type of event. **Fields:** | Name | Type | Description | | ------------------ | ------------------- | -------------------------------------- | | `events` | `[Event!]!` | The list of events. | | `pageInfoResponse` | `PageInfoResponse!` | Paging information for the result set. | ### EventsByTypeFilterType **Description:** Defines the filter types for future events. **Values:** | Value | Description | | --------------------------------- | ----------- | | `FUTURE_ROLE_START_ANNOUNCEMENT` | N/A | | `FUTURE_ROLE_END_ANNOUNCEMENT` | N/A | | `FUTURE_ROLE_CHANGE_ANNOUNCEMENT` | N/A |