POST
/
lists
/
Create List
curl --request POST \
  --url https://jobs-api.registercheck.de/api/v2/lists/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "tags": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "items": [
    {
      "entity_id": "<string>",
      "entity_name": "<string>",
      "is_company": true,
      "register_number": "<string>",
      "birth_date": "<string>",
      "notes": "<string>",
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "watchlist_subscription_id": "<string>"
    }
  ],
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "is_watchlist": false
}

Authorizations

Authorization
string
header
required

Enter your API key

Body

application/json

Request model for creating a new list

name
string
required

Name of the list

Required string length: 1 - 255
description
string | null

Optional description of the list

Maximum length: 1000
emoji
string | null

Optional emoji icon for the list

Maximum length: 10
tags
string[] | null

List of tag names to associate with the list

Response

Successful Response

Response model for a target list

id
string
required

Unique identifier for the list

name
string
required

Name of the list

created_at
string
required

ISO timestamp when the list was created

updated_at
string
required

ISO timestamp when the list was last updated

description
string | null

Optional description of the list

emoji
string | null

Optional emoji icon for the list

items
ListItemResponse · object[]

List of entities in this list

tags
TagResponse · object[]

Tags associated with this list

is_watchlist
boolean
default:false

Whether this list is a watchlist with active monitoring