Skip to main content
GET
/
api
/
v1
/
contacts
List all Contact Lists
curl --request GET \
  --url https://api.deliveryman.ai/api/v1/contacts/ \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "uid": "<string>",
      "workspace_id": 123,
      "name": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "source": "<string>",
      "available_columns": "<unknown>",
      "has_unsubscribe_column": true,
      "unsubscribe_column_name": "<string>"
    }
  ],
  "total": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.deliveryman.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Enter your API key in the format: X-Api-Key <your_key>

Query Parameters

​
limit
integer
required

Maximum number of records to fetch in the current page. Must be between 1 and 100.

Required range: 1 <= x <= 100
​
offset
integer
required

Number of records to skip before fetching the results.For example, an offset of 0 starts at the beginning, while an offset of 50 fetches records starting from the 51st. If offset is greater than number of records available, results will be empty.

Required range: x >= 0
​
workspace_id
integer | null
required

Fetch contact lists from this workspace only.

Response

Success

​
data
object[]
required
​
total
integer
required

Total number of contact lists in workspace if workspace_id is provided. Otherwise across all workspaces.

Required range: x >= 0