List senders

Lists saved sender addresses.

Permission

ADDRESSES_READ

See Troubleshooting for authentication, access, rate-limit, and service errors.

GET/senders

Authorization

AuthorizationBearer token · headerrequired

Required header: Authorization: Bearer <customer-api-key>. Use a Customer API key with the operation's required permission. Never use a dashboard or webshop token.

Query parameters

pageSizeinteger

Maximum records per page: 1–200, default 20. Results are newest first.

min 1 · max 200 · default: 20

cursorstring

Copy nextCursor from the previous response to fetch the next page. Keep the same filters; omit for the first page.

min length 1

filterstring

Optional case-insensitive substring search across name, email, city, and postal code. Omit or send an empty string to disable search.

statusstring

Filter by ACTIVE or ARCHIVED address status. Omit to include both.

Allowed:ACTIVEARCHIVED

Responses

200

Successful result

successanyrequired

messagestringrequired

dataobjectrequired

Show properties

sendersAddressRecord[]

Show properties

Array of AddressRecord

namestringrequired

Person or company name. Required and nonempty after trimming; see maxLength. Shipment services may impose a lower name limit.

min length 1 · max length 40

street1stringrequired

Primary street address, including house number. Required and nonempty after trimming; see maxLength and service fieldLimits.

min length 1 · max length 54

street2string | any

Optional additional address line. Omit or send null to clear it; see maxLength and service fieldLimits.

default: null

Show properties

Any of:

string

string

any

any

citystringrequired

Town or city. Required and nonempty after trimming; see maxLength.

min length 1 · max length 30

zipstringrequired

Postal code as text, preserving leading zeros. It must match the country for carrier shipments; see maxLength.

min length 1 · max length 10

countrystringrequired

Supported country code in two-letter uppercase ISO format, such as DK. The country and service must have an available route and price.

matches ^[A-Z]{2}$

addressTypestringrequired

RESIDENTIAL for a private address or COMMERCIAL for a business address.

Allowed:RESIDENTIALCOMMERCIAL

regionstring | any

Optional state, province, or region as text. Omit or send null to clear it.

default: null

Show properties

Any of:

string

string

any

any

attentionstring | any

Optional contact person or attention line. Omit or send null to clear it; see maxLength.

default: null

Show properties

Any of:

string

string

any

any

emailstring<email> | any

Valid contact email address, or null. Required for a shipment receiver when GET /services reports receiverEmailRequired.

default: null

Show properties

Any of:

string<email>

string<email>

any

any

phonestring | any

Telephone number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverPhoneRequired is true.

default: null

Show properties

Any of:

string

string

any

any

mobilestring | any

Mobile number in international E.164 format, such as +4512345678, or null. Required for a shipment receiver when receiverMobileRequired is true.

default: null

Show properties

Any of:

string

string

any

any

idstringrequired

Saved address ID belonging to the authenticated account.

statusstringrequired

ACTIVE or ARCHIVED address-book status. On update, omit to retain the current status. Changing an address does not rewrite shipment snapshots.

Allowed:ACTIVEARCHIVED

createdAtstring<date-time>required

Timestamp when this saved address was created.

nextCursorstring | null

requestIdstringrequired

400

Invalid input or unsupported operation.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

404

Resource does not exist or belongs to another account.

successanyrequired

messagestringrequired

dataanyrequired

requestIdstringrequired

errorCodestringrequired

errorsobject | anyrequired

Show properties

Any of:

object

fieldsobject[]

Show properties

Array of object

pathstringrequired

errorCodestringrequired

messagestringrequired

pricePrice

Show properties

currencystringrequired

baseAmountstringrequired

surchargeAmountstringrequired

palletExchangeAmountstringrequired

taxAmountstringrequired

totalAmountstringrequired

currentStatusstring

retryAfterSecondsinteger

min 1

any

any

Request

curl -X GET "https://bookogsend.dk/api/v1/customer/senders" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://bookogsend.dk/api/v1/customer/senders", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "success": true,
  "message": "Senders retrieved.",
  "data": {
    "senders": [],
    "nextCursor": null
  },
  "requestId": "<request-id>"
}

{
  "success": false,
  "message": "Invalid input or unsupported operation.",
  "data": null,
  "requestId": "request-id",
  "errorCode": "BAD_REQUEST",
  "errors": null
}

{
  "success": false,
  "message": "Resource does not exist or belongs to another account.",
  "data": null,
  "requestId": "request-id",
  "errorCode": "NOT_FOUND",
  "errors": null
}