{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounts Lists API", "version": "0.0.0" }, "items": [ { "info": { "name": "Lists", "type": "folder" }, "items": [ { "info": { "name": "List lists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists", "headers": [ { "name": "Lightfield-Version", "value": "2026-03-01" } ], "params": [ { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of lists. Use `offset` and `limit` to paginate through results. See [List endpoints](/using-the-api/list-endpoints/) for more information about pagination.\n\n**[Required scope](/using-the-api/scopes/):** `lists:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Search" }, { "info": { "name": "Create a list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/lists", "headers": [ { "name": "Lightfield-Version", "value": "2026-03-01" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new list. The `$name` and `$objectType` fields are required.\n\nSupports idempotency via the `Idempotency-Key` header.\n\n**[Required scope](/using-the-api/scopes/):** `lists:create`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Write" }, { "info": { "name": "Retrieve a list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists/:id", "headers": [ { "name": "Lightfield-Version", "value": "2026-03-01" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a single list by its ID.\n\n**[Required scope](/using-the-api/scopes/):** `lists:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Read" }, { "info": { "name": "Update a list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/lists/:id", "headers": [ { "name": "Lightfield-Version", "value": "2026-03-01" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates an existing list by ID. Only included fields are modified.\n\nSupports idempotency via the `Idempotency-Key` header.\n\n**[Required scope](/using-the-api/scopes/):** `lists:update`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Write" }, { "info": { "name": "List accounts in a list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists/:listId/accounts", "headers": [ { "name": "Lightfield-Version", "value": "2026-03-01" } ], "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of accounts that belong to the specified list.\n\n**[Required scopes](/using-the-api/scopes/):** `lists:read` and `accounts:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Search" }, { "info": { "name": "List contacts in a list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists/:listId/contacts", "headers": [ { "name": "Lightfield-Version", "value": "2026-03-01" } ], "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of contacts that belong to the specified list.\n\n**[Required scopes](/using-the-api/scopes/):** `lists:read` and `contacts:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Search" }, { "info": { "name": "List opportunities in a list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists/:listId/opportunities", "headers": [ { "name": "Lightfield-Version", "value": "2026-03-01" } ], "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of opportunities that belong to the specified list.\n\n**[Required scopes](/using-the-api/scopes/):** `lists:read` and `opportunities:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Search" } ] } ], "bundled": true }