--- updatedAt: 2026-06-30T16:05:21.000Z agentTools: projectIndex: https://docs.pelcro.com/llms.txt --- # List vendors Retrieve a paginated list of vendors. ## Overview Retrieve a paginated list of all vendors on the site. Supports filtering, sorting, searching, and expanding relationships. **Example:** List all vendors sorted by creation date, or search for a vendor by name or email. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "core-api", "version": "1.88" }, "servers": [ { "url": "https://www.pelcro.com/api/v1/core" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer" }, "sec1": { "type": "apiKey", "in": "query", "name": "site_id" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/vendors": { "get": { "summary": "List vendors", "description": "Retrieve a paginated list of vendors.", "operationId": "api-core-list-vendors", "parameters": [ { "name": "site_id", "in": "query", "description": "The unique identifier of the site associated with your account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "default": "Bearer eyJ***" } }, { "name": "page", "in": "query", "description": "The specific page of the result set you want to retrieve, typically used in conjunction with limit. For example, if you set page=2 and limit=10, the API will return the second page of results, containing a maximum of 10 objects starting from the 11th object.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "limit", "in": "query", "description": "The maximum number of objects you want returned per result set. For instance, if you set limit=10, the API will return a maximum of 10 objects in the response. (max: 100)", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Search vendors by name, email, or phone." }, { "name": "expand", "in": "query", "description": "An optional comma separated list of [supported relationships](https://docs.pelcro.com/reference/api-core-expanding-relationships#expandable-relationships) to expand. This endpoint supports expanding `bills`, `vendor` and `vendor.payoutDetail` relationships.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "One [supported attribute](https://docs.pelcro.com/reference/api-core-filtering-and-sorting#supported-endpoints-and-attributes) to sort on. Prefix with - for descending.", "schema": { "type": "string", "enum": [ "id", "-id", "first_name", "-first_name", "last_name", "-last_name", "email", "-email", "created_at", "-created_at" ] } }, { "name": "filter[id]", "in": "query", "schema": { "type": "string" }, "description": "Filter by vendor ID. Example: eq:42" }, { "name": "filter[first_name]", "in": "query", "schema": { "type": "string" }, "description": "Filter by first name. Example: like:jane" }, { "name": "filter[last_name]", "in": "query", "schema": { "type": "string" }, "description": "Filter by last name. Example: like:smith" }, { "name": "filter[email]", "in": "query", "schema": { "type": "string" }, "description": "Filter by email. Example: like:example.com" }, { "name": "filter[phone]", "in": "query", "schema": { "type": "string" }, "description": "Filter by phone. Example: like:555" } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "vendor_id": { "type": "integer" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "birthdate": { "type": "string", "nullable": true }, "job_title": { "type": "string", "nullable": true }, "delivery_service_area_prompt": { "type": "string", "nullable": true }, "bills_count": { "type": "integer" }, "total_billed": { "type": "number" }, "payout_ready": { "type": "boolean" }, "metadata": { "type": "object", "nullable": true }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } }, "status": { "type": "string" } } }, "examples": { "Default": { "value": "{\n \"data\": [\n {\n \"id\": 100,\n \"vendor_id\": 50,\n \"name\": \"Jane Smith\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jane.smith@example.net\",\n \"phone\": \"+1-555-0123\",\n \"birthdate\": null,\n \"job_title\": \"Freelance Writer\",\n \"delivery_service_area_prompt\": null,\n \"bills_count\": 0,\n \"total_billed\": 0,\n \"payout_ready\": false,\n \"metadata\": null,\n \"created_at\": 1650974042,\n \"updated_at\": 1650974042\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 1,\n \"per_page\": 10\n }\n}" }, "Expanded": { "value": "{\n \"data\": [\n {\n \"id\": 100,\n \"vendor_id\": 50,\n \"name\": \"Jane Smith\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jane.smith@example.net\",\n \"phone\": \"+1-555-0123\",\n \"birthdate\": null,\n \"job_title\": \"Freelance Writer\",\n \"delivery_service_area_prompt\": null,\n \"bills_count\": 0,\n \"total_billed\": 0,\n \"payout_ready\": false,\n \"metadata\": null,\n \"created_at\": 1650974042,\n \"updated_at\": 1650974042,\n \"bills\": [],\n \"vendor\": {\n \"id\": 50,\n \"user_id\": 100,\n \"account_id\": 1,\n \"birthdate\": null,\n \"job_title\": \"Freelance Writer\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total\": 1,\n \"per_page\": 10\n }\n}" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "examples": { "Result": { "value": { "error": { "status": 400, "message": "Invalid request, please try again." } } } } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "examples": { "Result": { "value": { "error": "Unauthenticated." } } } } } } }, "deprecated": false, "x-readme": { "code-samples": [ { "language": "php", "code": "use GuzzleHttp\\Client;\n\n$site_id = 0; // (int) your site id here\n$page = 1; // (int) the page number here\n \n$api_key = '' // (string) your api key here\n$uri = \"vendors\";\n\n$config = [\n 'base_uri' => 'https://www.pelcro.com/api/v1/core/'\n];\n\n$client = new Client($config);\n\n$options = [\n\t'json' => [\n\t\t'site_id' => $site_id,\n\t\t'page' => $page,\n\t],\n\t'headers' => [\n\t\t'Accept' => 'application/json',\n\t\t'Authorization' => 'Bearer ' . $api_key\n\t]\n];\n\n$response = $client->request('GET', $uri, $options);" } ], "samples-languages": [ "php" ] } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ``` # Sibling pages * [Create vendor](https://docs.pelcro.com/reference/api-core-create-vendor.md) * [Get vendor](https://docs.pelcro.com/reference/api-core-get-vendor.md) * [Update vendor](https://docs.pelcro.com/reference/api-core-update-vendor.md) * [Delete vendor](https://docs.pelcro.com/reference/api-core-delete-vendor.md) * [Export vendors](https://docs.pelcro.com/reference/api-core-export-vendors.md) * [Payout Details](https://docs.pelcro.com/reference/api-core-vendor-payout-details.md)