Search your business's recipients
The people and companies your key's business has issued documents to in its environment, most recent first: they are added on their own when you issue or import. q searches by name or identification; counts counts its recipients without filtering.
Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.
In: header
Query Parameters
How many per page, from 1 to 100.
1 <= value <= 10020The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.
length <= 200Words of the name (ignoring case and accents), or the start of a RUC or cedula.
1 <= length <= 100pending: only those who asked to change their email from the portal and await your decision.
Value in
- "pending"
true: only those whose email bounced (email_bounced), so you can reach them another way.
Value in
- "true"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/ec/recipients"{ "object": "list", "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "recipient", "identification": "string", "name": "string", "email": "string", "currency": "string", "year_count": 0, "year_total": "string", "sales_total": "string", "phone": "string", "email_bounced": true, "last_issue_date": "2019-08-24", "sri_status": "active", "portal_request": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "email": "user@example.com", "created_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string", "prev_cursor": "string", "counts": { "all": 0, "portal_request": 0, "email_bounced": 0 }}