Lists

Lists

Display a listing of IAM lists in a workspace.

get

Path parameters

workspaceIdstringRequired

ID of the workspace

Query parameters

namestringOptional

Filter lists by name

identifierstringOptional

Filter lists to include only those with contacts having a specified identifier (e.g., phone-number, email)

per_pageintegerOptional

Number of items per page for pagination

Default: 15

pageintegerOptional

Page number for pagination

Default: 1

Responses

200

Successful operation

application/json

401

Unauthenticated

application/json

403

Forbidden

application/json

get

api/workspaces/{workspaceId}/lists

HTTPcURLJavaScriptPython

GET api/workspaces/{workspaceId}/lists HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Customer List",
      "workspace_id": "workspace123",
      "contacts_count": 5,
      "type": "general",
      "description": "List of customers",
      "created_at": 1632332800,
      "updated_at": 1632927600
    }
  ],
  "pagination": {
    "total": 50,
    "per_page": 15,
    "current_page": 1,
    "last_page": 4,
    "from": 1,
    "to": 15
  }
}

Store a newly created list.

post

Authorizations

apiAuth

Path parameters

workspaceIdstringRequired

ID of the workspace

Body

application/json

namestringOptional

Name of the list

Example: Example List

descriptionstringOptional

Description of the list

Example: This is an example list.

contact_idsstring[]Optional

Array of contact IDs

Example: dd479c4d-7ce6-439e-9adc-6d128a1b6e2d

Responses

201

List created successfully

application/json

400

Validation Error(s)

application/json

404

Workspace not found

application/json

post

/api/workspaces/{workspaceId}/lists

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspaceId}/lists HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "name": "Example List",
  "description": "This is an example list.",
  "contact_ids": [
    "dd479c4d-7ce6-439e-9adc-6d128a1b6e2d"
  ]
}

{
  "message": "List created successfully",
  "list": {}
}

Show a list

get

Display a list by ID

Path parameters

workspaceIdstringRequired

ID of the workspace

listIdstringRequired

ID of the list to show

Responses

200

List found

application/json

404

List not found

application/json

get

/api/workspaces/{workspaceId}/lists/{listId}

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/lists/{listId} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "name": "text",
  "workspace_id": 1,
  "type": "text",
  "description": "text",
  "created_at": 1,
  "updated_at": 1
}

Update a list

put

Update a list by ID

Path parameters

idstringRequired

ID of the list to update

Body

application/json

idintegerOptional

namestringOptional

workspace_idintegerOptional

typestringOptional

descriptionstring | nullableOptional

created_atinteger · timestampOptional

updated_atinteger · timestampOptional

Responses

200

List updated successfully

application/json

404

List not found

put

/api/workspaces/{workspaceId}/lists/{id}

HTTPcURLJavaScriptPython

PUT /api/workspaces/{workspaceId}/lists/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "id": 1,
  "name": "text",
  "workspace_id": 1,
  "type": "text",
  "description": "text",
  "created_at": 1,
  "updated_at": 1
}

{
  "id": 1,
  "name": "text",
  "workspace_id": 1,
  "type": "text",
  "description": "text",
  "created_at": 1,
  "updated_at": 1
}

Display a listing of the contacts by list ID.

get

Retrieve a list of contacts associated with a specific list.

Path parameters

workspaceIdstringRequired

ID of the workspace

listIdstringRequired

ID of the list

Query parameters

per_pageintegerOptional

Number of records per page

pageintegerOptional

Page number for pagination

Responses

200

Contacts retrieved successfully

application/json

404

Workspace or List not found

application/json

get

/api/workspaces/{workspaceId}/lists/{listId}/contacts

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/lists/{listId}/contacts HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "id": "text",
      "workspace_id": "text",
      "identifiers": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "attributes": {}
    }
  ],
  "pagination": {},
  "message": "text"
}