NEnex
Lists

Get records from a specific list

Changed on

Retrieves all records that belong to a specific list with pagination

post/v1/lists/{id}/records

Request

  • Base URL
    https://app.nex.ai/api/developers
  • Auth
    API key in header Authorization

Path parameters

idinteger required

List ID

Request body

limitinteger
offsetinteger

Example request

{
  "attributes": "all",
  "limit": 50,
  "offset": 0,
  "sort": {
    "attribute": "name",
    "direction": "asc"
  }
}

Response

List of records with pagination info

limitinteger
offsetinteger
totalinteger

Example response

{
  "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": [
          "alice@techcorp.com"
        ],
        "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": [
          "bob@startup.io"
        ],
        "job_title": "Founder",
        "location": {
          "city": "San Francisco",
          "region": "CA",
          "country": "US"
        }
      }
    }
  ],
  "limit": 50,
  "offset": 0,
  "total": 247
}

Changes