Skip to main content
POST
/
v1
/
lists
/
{id}
/
records
Get records from a specific list
curl --request POST \
  --url https://app.nex.ai/api/developers/v1/lists/{id}/records \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": "all",
  "limit": 50,
  "offset": 0,
  "sort": {
    "attribute": "name",
    "direction": "asc"
  }
}
'
{
  "data": [
    {
      "id": "32414268188027655",
      "object_id": "32414268188027650",
      "type": "person",
      "workspace_id": "32414268188027645",
      "created_at": "2024-01-15T14:20:00Z",
      "updated_at": "2024-01-20T09:15:00Z",
      "attributes": {
        "name": {
          "first_name": "Alice",
          "last_name": "Johnson"
        },
        "email_addresses": [
          "[email protected]"
        ],
        "job_title": "Product Manager",
        "phone_number": {
          "country_code": 1,
          "number": "5551112222"
        }
      }
    },
    {
      "id": "32414268188027656",
      "object_id": "32414268188027650",
      "type": "person",
      "workspace_id": "32414268188027645",
      "created_at": "2024-01-16T08:30:00Z",
      "updated_at": "2024-01-16T08:30:00Z",
      "attributes": {
        "name": {
          "first_name": "Bob",
          "last_name": "Wilson"
        },
        "email_addresses": [
          "[email protected]"
        ],
        "job_title": "Founder",
        "location": {
          "city": "San Francisco",
          "region": "CA",
          "country": "US"
        }
      }
    }
  ],
  "limit": 50,
  "offset": 0,
  "total": 247
}

Authorizations

Authorization
string
header
required

API key for authentication (format: "Bearer YOUR_API_KEY")

Path Parameters

id
integer
required

List ID

Body

application/json

List records request with pagination options

attributes

Attributes parameter supports both string values ('all', 'primary', 'none') and object format for custom selection

Available options:
all,
primary,
none
limit
integer
offset
integer
sort
object

Response

List of records with pagination info

data
object[]
limit
integer
offset
integer
total
integer