Docs

Places People B2C Links Profilefuse Financial Data Historical Data

Learn more about our data, services, and APIs.

Record Lists API

< Prev Next >

Create and manage lists of Infogroup IDs

Overview

Use the Record Lists API to create and manage lists of record IDs. Record Lists are associated with the authenticated customer's accessible contracts and organizations. The API never accepts or returns internal organization or contract IDs.

The document type is derived from the selected contract. Include its existing public contract reference when creating a list.

Creating a Record List

POST /v1/record_lists

Create an empty Record List with a contract reference and name:

curl https://qa.api.data-axle.com/v1/record_lists -XPOST -d '
{
  "contract": "your-contract-reference",
  "name": "September customers"
}'

The response includes the new list's public metadata:

{
  "id": 123,
  "name": "September customers",
  "document_type": "place",
  "error_message": null,
  "created_at": "2026-09-17T19:00:00Z",
  "updated_at": "2026-09-17T19:00:00Z"
}

View All Record Lists

GET /v1/record_lists

This returns every accessible, active Record List. Fetch one list by ID with:

GET /v1/record_lists/:id

Update Record List Name

PATCH /v1/record_lists/:id

Update a Record List name:

curl https://qa.api.data-axle.com/v1/record_lists/:id -XPATCH -d '
{
  "name": "October customers"
}'

Adding Records

PUT /v1/record_lists/:id/entries

Add entries with an entries JSON array. Use the list's ID field, such as company_id. For a Record List configured with a different UI ID field, use that field's exact attribute name. Entry processing is asynchronous, so a newly added entry may not appear in an immediate download.

curl https://qa.api.data-axle.com/v1/record_lists/:id/entries -XPUT -d '
{
  "entries": [
    { "company_id": "123456789" },
    { "company_id": "234567890" }
  ]
}'

{
  "status": "ok"
}

Downloading Records

GET /v1/record_lists/:id/entries

Entries are returned in ID order. The API returns a limited number of records per request. To retrieve the complete list, pass the last returned entry ID as the after parameter in the next request. Continue until the API returns an empty response:

GET /v1/record_lists/:id/entries?after=1000

Removing Records

DELETE /v1/record_lists/:id/entries

Remove specific entries using the list's ID field:

curl https://qa.api.data-axle.com/v1/record_lists/:id/entries -XDELETE -d '
{
  "entries": [
    { "company_id": "345678901" },
    { "company_id": "456789012" }
  ]
}'

{
  "status": "ok"
}

Deleting a Record List

DELETE /v1/record_lists/:id

Deleting a list removes it from the API and enqueues cleanup of its entries and record associations.

< Prev Next >