Listmembers

Listmembers endpoints for the CRM API Unified API

10.38.1

The ListMember resource represents a single CRM record that belongs to a List, identified by its downstream id and the type of record it is.

The ListMembers model

idstring

required

The unique identifier of the record that belongs to the List, as returned by the downstream connector.

object_typestring or null

The type of CRM record this member is. Normalized to a lowercase plural noun for the vendor's standard object types (e.g. contacts, companies, opportunities, leads, tickets, campaigns, tasks, events); for vendor-specific or custom object types the raw downstream identifier is passed through unchanged, mirroring the semantics of List.object_type. This field is intentionally open-ended — no closed enum is enforced.

ListMembers example

{}

List list members

get

https://unify.apideck.com/crm/lists/{id}/members

Retrieve the records that belong to a List. Returns a paginated set of members, each carrying the downstream record id and its object_type. Use this to enumerate the contents of a List (for example the contacts or companies a HubSpot list contains) instead of dropping to the proxy.

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstringnon-empty

required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Query parameters

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]

Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200List Members

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Act

Request

ActiveCampaign

Request

Attio

Request

Blackbaud

Request

Copper

Request

Flexmail

Request

Folk

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

HubSpot

Request

Microsoft Dynamics CRM

Request

Microsoft Outlook

Request

Odoo

Request

Pipedrive

Request

Planhat

Request

Salesflare

Request

Salesforce

Request

Teamleader

Request

Zendesk Sell

Request

Zoho CRM

Request

Request example

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.crm.listMembers.list({
    id: "<id>",
    serviceId: "salesforce",
    passThrough: {
      "search": "San Francisco",
    },
    fields: "id,updated_at",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "hubspot",
  "resource": "list-members",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "object_type": "contacts"
    }
  ],
  "_raw": {},
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "error": "string",
        "operation": "getManager",
        "message": "string"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}