GET
/
v3
/
data_points
Get list of all data points
curl --request GET \
  --url https://{region}.affinda.com/v3/data_points \
  --header 'Authorization: Bearer <token>'
[
  {
    "identifier": "XprEvgai",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "annotationContentType": "text",
    "organization": {
      "identifier": "mEFayXdO",
      "name": "Grove Street King",
      "userRole": "admin",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
      "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
      "isTrial": true,
      "validationToolConfig": {
        "theme": {
          "palette": {
            "mode": "light",
            "background": "<string>",
            "text": {
              "primary": "<string>",
              "secondary": "<string>",
              "disabled": "<string>"
            },
            "divider": "<string>",
            "primary": {
              "main": "<string>",
              "light": "<string>",
              "dark": "<string>",
              "contrastText": "<string>"
            },
            "secondary": {
              "main": "<string>",
              "light": "<string>",
              "dark": "<string>",
              "contrastText": "<string>"
            },
            "success": {
              "main": "<string>",
              "light": "<string>",
              "dark": "<string>",
              "contrastText": "<string>"
            },
            "annotation": {
              "main": "<string>",
              "light": "<string>",
              "dark": "<string>",
              "contrastText": "<string>"
            },
            "error": {
              "main": "<string>",
              "light": "<string>",
              "dark": "<string>",
              "contrastText": "<string>"
            },
            "info": {
              "main": "<string>",
              "light": "<string>",
              "dark": "<string>",
              "contrastText": "<string>"
            },
            "warning": {
              "main": "<string>",
              "light": "<string>",
              "dark": "<string>",
              "contrastText": "<string>"
            }
          },
          "typography": {
            "fontFamily": "<string>",
            "fontSize": "<string>",
            "fontWeightRegular": "<string>",
            "fontWeightMedium": "<string>",
            "fontWeightBold": "<string>"
          },
          "borderRadius": 123,
          "fontUrl": "<string>"
        },
        "hideActions": true,
        "hideCollection": true,
        "hideEditPages": true,
        "hideExport": true,
        "hideFilename": true,
        "hideReject": true,
        "hideReparse": true,
        "hideRunOcr": true,
        "hideTags": true,
        "hideWarnings": true,
        "restrictDocumentSplitting": true,
        "disableCurrencyFormatting": true,
        "disableEditDocumentMetadata": true
      },
      "showCustomFieldCreation": true
    },
    "extractor": "resume",
    "multiple": true,
    "noRect": true,
    "parent": "DdCbJhhx",
    "children": [
      {}
    ],
    "availableDataSources": [
      {
        "identifier": "mEFayXdO",
        "name": "My supplier list",
        "keyProperty": "value",
        "displayProperty": "value",
        "organization": "mewlkWEKL",
        "workspace": "mewlkWEKL",
        "schema": {
          "type": "object",
          "$schema": "http://json-schema.org/draft-07/schema#",
          "required": [
            "label"
          ],
          "properties": {
            "label": {
              "type": "string"
            },
            "description": {
              "type": "string"
            }
          }
        }
      }
    ],
    "mappingDataSource": "mEFayXdO",
    "manualEntry": true
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Query Parameters

​
offset
integer

The number of documents to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

​
limit
integer

The numbers of results to return.

Required range: 1 <= x <= 100
Example:

20

​
organization
string

Filter by organization.

Example:

"mEFayXdO"

​
include_public
boolean

Allows you to include public data points in the response when you're filtering by organization.

​
extractor
string

Filter by extractor.

Example:

"resume"

​
slug
string

Filter by slug.

​
description
string

Filter by description.

​
annotation_content_type
string

Filter by annotation content type, e.g. text, integer, float, date, etc.

​
identifier
string[]

Filter by specific identifiers.

Uniquely identify a data point.

Response

200
application/json

All matching data points.

The response is of type object[].