> ## Documentation Index > Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt > Use this file to discover all available pages before exploring further. # ListAnnotation > Retrieves annotations using an optional filter. ## OpenAPI ````yaml /openapi.json get /api/v1/annotations openapi: 3.0.0 info: title: Sift API version: '1.0' servers: - url: https://api.siftstack.com description: Production - url: https://gov.api.siftstack.com description: Gov security: - BearerAuth: [] tags: - name: TagService description: Service to programmatically interact with [tags](/glossary#tag). - name: ProtobufDescriptorService description: >- Service to programmatically interact with protobuf desciptors used for protobuf ingestion. externalDocs: description: Read more about what protobuf ingestion. url: /ingestion/protobuf_ingestion - name: ApiKeyService - name: UnitService - name: ChannelSchemaService description: Service to programmatically interact with channel schemas - name: PingService - name: SavedSearchService - name: IngestService - name: UserDefinedFunctionService - name: RoleService - name: DataImportService - name: AnnotationLogService description: >- Service to programmatically interact with [annotation logs](/glossary#annotation). externalDocs: description: Read more about annotations. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265486685 - name: ExportService - name: AnnotationService description: Service to programmatically interact with annotations. externalDocs: description: Read more about annotations. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265486685 - name: RuleEvaluationService description: Service to evaluate rules. externalDocs: description: Read more about what rules are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421102 - name: CalculatedChannelsService description: Service to programmatically interact with calculated channels. externalDocs: description: Read more about calculated channels. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421153 - name: CalculatedChannelService - name: MeService - name: UserService description: Service to programmatically interact with user objects. - name: RuleService description: Service to programmatically interact with rules. externalDocs: description: Read more about what rules are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421102 - name: RemoteFileService - name: CampaignService - name: ReportTemplateService - name: JobService - name: DlqErrorsService - name: WebhookService - name: DataService description: Service to query data - name: ViewService description: Service to programmatically interact with views. externalDocs: description: Read more about what views are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/298188809 - name: AssetService description: Service to programmatically interact with [assets](/glossary#asset). externalDocs: description: Read more about what assets are. url: /data-model - name: UserGroupService - name: RunService description: Service to programmatically interact with [runs](/glossary#run). externalDocs: description: Read more about what runs are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265454053 - name: MetadataService - name: NotificationService description: Service to programmatically interact with in-app notifications. - name: PanelConfigurationService description: Service to programmatically interact with panel configurations. - name: IngestionConfigService description: >- Service to programmatically interact with [ingestion configs](/glossary#ingestion-config). externalDocs: description: Read more about what ingestion configs are. url: /ingestion/creating-amend-ingestion-config - name: ReportService - name: ExternalSyncService - name: ChannelService description: Service to programmatically interact with [channels](/glossary#channel). externalDocs: description: Read more about what channels are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265453943 paths: /api/v1/annotations: get: tags: - AnnotationService summary: ListAnnotation description: Retrieves annotations using an optional filter. operationId: AnnotationService_ListAnnotations parameters: - name: pageSize description: >- The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. in: query required: false schema: type: integer format: int64 - name: pageToken description: >- A page token, received from a previous `ListAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnotations` must match the call that provided the page token. Optional. in: query required: false schema: type: string - name: filter description: >- A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `annotation_id`, `start_time`, `end_time`, `created_date`, `modified_date`, `run_id`, `name`, `description`, `state`, `created_by_user_id`, `created_by_rule_condition_version_id`, `annotation_type`, `tag_name`, `report_id`, `asset_id`, `asset_name`, `pending`, `assignee`, `campaign_reports`, and `metadata`. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/annotations#annotation). Optional. in: query required: false schema: type: string - name: organizationId description: >- This field is only required if your user belongs to multiple organizations. in: query required: false schema: type: string - name: orderBy description: >- How to order the retrieved annotations. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are `created_date`, `modified_date`, `start_time`, `end_time`, `name`, and `description`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read [this](https://google.aip.dev/132#ordering) Example: "created_date desc,modified_date" in: query required: false schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ListAnnotationsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/rpcStatus' components: schemas: v1ListAnnotationsResponse: type: object properties: annotations: type: array items: $ref: '#/components/schemas/annotationsv1Annotation' nextPageToken: type: string description: >- Oops, we skipped to index 5! No reason for that; the indices between aren't reserved or anything. description: The result of a call to `AnnotationService_ListAnnotations`. rpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' annotationsv1Annotation: type: object properties: annotationId: type: string name: type: string description: type: string startTime: type: string format: date-time endTime: type: string format: date-time createdByUserId: type: string modifiedByUserId: type: string createdDate: type: string format: date-time modifiedDate: type: string format: date-time runId: type: string state: $ref: '#/components/schemas/v1AnnotationState' organizationId: type: string assignedToUserId: type: string annotationType: $ref: '#/components/schemas/v1AnnotationType' tags: type: array items: type: string legendConfig: type: string createdByConditionId: type: string createdByRuleConditionVersionId: type: string reportRuleVersionId: type: string pending: type: boolean description: >- An annotation is pending if it is part of an ongoing violation of a rule condition. The `end_time` of a pending annotation might be set, but is not yet finalized. readOnly: true assignedToUser: $ref: '#/components/schemas/v1User' deletedDate: type: string format: date-time linkedChannels: type: array items: $ref: '#/components/schemas/v1AnnotationLinkedChannel' assetIds: type: array items: type: string metadata: type: array items: $ref: '#/components/schemas/v1MetadataValue' required: - annotationId - name - description - startTime - endTime - createdByUserId - modifiedByUserId - createdDate - modifiedDate - organizationId - annotationType - tags protobufAny: type: object properties: '@type': type: string description: >- A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. additionalProperties: {} description: >- `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } v1AnnotationState: type: string enum: - ANNOTATION_STATE_UNSPECIFIED - ANNOTATION_STATE_OPEN - ANNOTATION_STATE_FLAGGED - ANNOTATION_STATE_RESOLVED default: ANNOTATION_STATE_UNSPECIFIED v1AnnotationType: type: string enum: - ANNOTATION_TYPE_UNSPECIFIED - ANNOTATION_TYPE_DATA_REVIEW - ANNOTATION_TYPE_PHASE default: ANNOTATION_TYPE_UNSPECIFIED v1User: type: object properties: userId: type: string userName: type: string organizations: type: array items: $ref: '#/components/schemas/v1Organization' required: - userId - userName v1AnnotationLinkedChannel: type: object properties: channel: $ref: '#/components/schemas/v1AnnotationLinkedChannelsChannel' bitFieldElement: $ref: '#/components/schemas/v1AnnotationLinkedChannelsBitFieldElement' v1MetadataValue: type: object properties: key: $ref: '#/components/schemas/v1MetadataKey' stringValue: type: string numberValue: type: number format: double booleanValue: type: boolean archivedDate: type: string format: date-time required: - key v1Organization: type: object properties: organizationId: type: string organizationName: type: string required: - organizationId - organizationName v1AnnotationLinkedChannelsChannel: type: object properties: channelId: type: string required: - channelId v1AnnotationLinkedChannelsBitFieldElement: type: object properties: channelId: type: string bitFieldName: type: string required: - channelId - bitFieldName v1MetadataKey: type: object properties: name: type: string type: $ref: '#/components/schemas/v1MetadataKeyType' archivedDate: type: string format: date-time required: - name - type v1MetadataKeyType: type: string enum: - METADATA_KEY_TYPE_UNSPECIFIED - METADATA_KEY_TYPE_STRING - METADATA_KEY_TYPE_NUMBER - METADATA_KEY_TYPE_BOOLEAN default: METADATA_KEY_TYPE_UNSPECIFIED description: |- Metadata key type. - METADATA_KEY_TYPE_STRING: string - METADATA_KEY_TYPE_NUMBER: number - METADATA_KEY_TYPE_BOOLEAN: boolean securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````