Addresses - List
Lista endereços com filtros e paginação. Use para telas de gestão ou para sincronizar com seu CRM/ERP.
Lista endereços com filtros e paginação. Use para telas de gestão ou para sincronizar com seu CRM/ERP.
Authorization
SelectKeyAuth API key for all authenticated requests. Send your key in the selectkey header (e.g. sandbox sl_test_…, production sl_live_…).
In: header
Query Parameters
Maximum number of items to return
Number of items to skip
Sort order for results
Filter by customer ID
Exact datetime range filter (legacy)
Created after (greater than)
Lower bound (inclusive): include only records whose date field is on or after this value.
Upper bound (exclusive): include only records whose date field is strictly before this value.
Upper bound (inclusive): include only records whose date field is on or before this value.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/addresses?limit=20&offset=0&sort=descending&customerid=cus_abc123&daterange=2026-01-15T10%3A30%3A00Z&daterangegt=Example+text&daterangegte=2026-01-01T00%3A00%3A00Z&daterangelt=2026-01-01T00%3A00%3A00Z&daterangelte=2026-01-01T00%3A00%3A00Z"{
"offset": 0,
"limit": 25,
"total": 42,
"page": {
"offset": {
"first": 0,
"prev": null,
"next": 25,
"last": 25
},
"current": 1,
"total": 2
},
"data": [
{
"id": "addr_01hqzvabc",
"street": "Av. Paulista",
"number": "1000",
"complement": "Sala 1",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"country": "BR",
"postcode": "01310100",
"latitude": null,
"longitude": null,
"lineAddress": "Av. Paulista, 1000 - Bela Vista, São Paulo - SP, 01310100",
"metadata": null,
"primary": true,
"ownerType": "customer",
"ownerId": "cus_01hqzvabc",
"updatedAt": "2026-04-12T17:56:33.000Z",
"createdAt": "2026-04-12T17:56:33.000Z"
}
],
"hasMore": true,
"merchant": {
"name": "Seller Name",
"merchantId": "bus_1234567890",
"isSubAccount": false
},
"_links": {
"self": {
"href": "https://api.selectwin.io/v1/addresses",
"method": "GET",
"description": "List all addresses."
},
"create": {
"href": "https://api.selectwin.io/v1/addresses",
"method": "POST",
"description": "Create a new address."
}
}
}{
"error": {
"status": "Bad Request",
"statusCode": 400,
"category": "validation",
"message": "Validation errors occurred",
"details": "One or more parameters are invalid or out of range. Please check the parameters and try again.",
"params": [
{
"payment[currency]": "currency must be one of [BRL]"
},
{
"amount": "amount is required"
}
],
"code": "invalidParameters",
"resource": "client"
}
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"message": "Unauthorized",
"details": "Authentication failed. The provided API key is invalid or does not have permission to operate.",
"code": "unauthorized"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"message": "Forbidden",
"details": "Access denied. This may be due to IP blocks, domain restrictions, or insufficient permissions.",
"code": "forbidden"
}
}{
"error": {
"status": "Not Found",
"statusCode": 404,
"category": "client",
"message": "Not Found",
"details": "The requested resource was not found on the server.",
"code": "notFound"
}
}{
"error": {
"status": "Unprocessable Entity",
"statusCode": 422,
"category": "validation",
"message": "Unprocessable Entity",
"details": "The request was understood, but contains invalid data that could not be processed.",
"code": "unprocessableEntity"
}
}{
"error": {
"status": "Too Many Requests",
"statusCode": 429,
"category": "rate_limit",
"message": "Too Many Requests",
"details": "The number of requests exceeded the limit allowed for the IP or user.",
"retryAfterMinutes": 60,
"code": "tooManyRequests"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"message": "Server error.",
"details": "An internal server error occurred. Please try again later.",
"code": "serverError",
"resource": "server"
}
}