> ## Documentation Index > Fetch the complete documentation index at: https://sendcloud.dev/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a list of pickups > Get information about all the pickups which have been created from your account. This endpoint uses cursor-based pagination via `Link` headers. See [Pagination](/api/v3/pagination) for details. This is limited to the [carriers which support pickups via the API](/api/v3/pickups#which-carriers-support-pickups-via-the-api). The response includes information about when the pickup was scheduled, the latest status, the parcel tracking number and the time frame in which the pickup is due to take place. ## OpenAPI ````yaml /.openapi/v3/pickups/openapi.yaml get /pickups openapi: 3.1.0 info: title: Pickups API version: 3.0.0 contact: name: Sendcloud API Support url: https://www.sendcloud.dev email: contact@sendcloud.com description: >- The Pickups API lets you schedule a one-time parcel pickup with supported carriers. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://panel.sendcloud.sc/api/v3 description: Sendcloud Production security: [] tags: - name: Pickups description: >- The pickup is a delivery option when a carrier collects parcels at a specific address and time, and then delivers them to the sorting center. paths: /pickups: get: tags: - Pickups summary: Retrieve a list of pickups description: >- Get information about all the pickups which have been created from your account. This endpoint uses cursor-based pagination via `Link` headers. See [Pagination](/api/v3/pagination) for details. operationId: sc-public-v3-scp-get-all_pickups parameters: - schema: type: integer minimum: 1 maximum: 100 example: 10 in: query name: page_size description: Amount of pickups that will be shown per page. responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/list-pickup-response' examples: RetrieveDHLExpressPickups: summary: Retrieve a list of DHL Express pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: NL carrier_code: dhl_express tracking_number: PRG220406003404 status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: NL carrier_code: dhl_express tracking_number: PRG220406002044 status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveFedexPickups: summary: Retrieve a list of Fedex pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: ES carrier_code: fedex tracking_number: PRG220406003404 status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: ES carrier_code: fedex tracking_number: PRG220406002044 status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveCorreosExpressPickups: summary: Retrieve a list of Correos Express pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: ES carrier_code: correos_express tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: ES carrier_code: correos_express tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveCorreosPickups: summary: Retrieve a list of Correos pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: ES carrier_code: correos tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: ES carrier_code: correos tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrievePosteItDeliveryCorreosPickups: summary: Retrieve a list of Poste Italiane Delivery pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: IT carrier_code: poste_it_delivery tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: IT carrier_code: poste_it_delivery tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveGlsItCorreosPickups: summary: Retrieve a list of GLS Italy pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: IT carrier_code: gls_it tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: IT carrier_code: gls_it tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveUPSPickups: summary: Retrieve a list of UPS pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: GB carrier_code: ups tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: GB carrier_code: ups tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveDhlParcelIberiaPickups: summary: Retrieve a list of DHL Parcel Iberia pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: PT carrier_code: dhe_parcel_iberia tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: PT carrier_code: dhe_parcel_iberia tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveHermesGermanyPickups: summary: Retrieve a list of Hermes Germany pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T09:00:00Z' end_at: '2022-04-06T12:00:00Z' country: NL carrier_code: hermes_de tracking_number: PRG220406003404 status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T11:00:00Z' end_at: '2022-04-06T14:00:00Z' country: NL carrier_code: hermes_de tracking_number: PRG220406002044 status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveDHLPickups: summary: Retrieve a list of DHL pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: NL carrier_code: dhl tracking_number: PRG220406003404 status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: NL carrier_code: dhl tracking_number: PRG220406002044 status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveDPDATPickups: summary: Retrieve a list of DPD AT pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: AT carrier_code: dpd_at tracking_number: 220406003404 status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: AT carrier_code: dpd_at tracking_number: 220406002044 status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveBRTPickups: summary: Retrieve a list of BRT pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: IT carrier_code: brt tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: IT carrier_code: gls_it tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveDPDPickups: summary: Retrieve a list of DPD pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: DE carrier_code: dpd tracking_number: '100113932' status: CANCELLED created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: DE carrier_code: dpd tracking_number: '100113933' status: CANCELLED created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' contract_id: 10 RetrieveDhlDePickups: summary: Retrieve a list of DHL DE pickups value: data: id: 1 time_slots: - start_at: '2022-04-06T09:00:00Z' end_at: '2022-04-06T12:00:00Z' items: - quantity: 5 container_type: parcel total_weight: value: '2.00' unit: kg reference: '' special_instructions: '' tracking_number: '' status: ANNOUNCING created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: null carrier_code: dhl_de contract_id: null FailedPickups: summary: Retrieve a list of failed pickups value: data: - id: 1 time_slots: - start_at: '2022-04-06T12:00:00Z' end_at: '2022-04-06T17:00:00Z' country: NL carrier_code: dhl_express tracking_number: '' status: FAILED created_at: '2022-03-30T10:58:09.832504Z' cancelled_at: null headers: Link: description: >- The pagination links, according to the web linking specification (RFC8288). schema: type: string example: >- ; rel="prev", ; rel="next" security: - HTTPBasicAuth: [] - OAuth2ClientCreds: [] components: schemas: list-pickup-response: title: Pickup Object (List Item) description: Sendcloud pickup object, returned through a list. type: object properties: id: type: integer format: int64 minimum: 1 description: Unique identifier of the pickup. carrier_code: type: string minLength: 1 country: type: string minLength: 2 maxLength: 2 example: NL description: ISO 3166-1 alpha-2 country code. enum: - NL - BE - DE - ES - FR - IT - AT - PT - GB tracking_number: type: string minLength: 0 time_slots: $ref: '#/components/schemas/time-slot-list' status: type: string enum: - CREATED - CANCELLED - FAILED - ANNOUNCING created_at: type: string format: date-time description: ISO 8601 DateTime at which the pickup is created. cancelled_at: type: - string - 'null' format: date-time description: ISO 8601 DateTime at which the pickup is cancelled. contract_id: type: integer description: ID of the contract that is used to create the pickup. time-slot-list: title: Time Slot List type: array description: >- Scheduled time slots for the pickup. Note that most carriers only support a single time slot. items: type: object allOf: - $ref: '#/components/schemas/time-slot' time-slot: title: Time Slot Object type: object properties: start_at: type: string format: date-time description: Scheduled pickup time in ISO 8601 DateTime format. end_at: type: - string - 'null' format: date-time description: >- ISO 8601 DateTime of the pickup location close time. This could be useful in case the pickup is delayed. securitySchemes: HTTPBasicAuth: type: http description: >- Basic Authentication using API key and secrets is currently the main authentication mechanism. scheme: basic OAuth2ClientCreds: type: oauth2 description: >- OAuth2 is a standardized protocol for authorization that allows users to share their private resources stored on one site with another site without having to provide their credentials. OAuth2 Client Credentials Grant workflow. This workflow is typically used for server-to-server interactions that require authorization to access specific resources. flows: clientCredentials: tokenUrl: https://account.sendcloud.com/oauth2/token/ scopes: api: Default OAuth scope required to access Sendcloud API. ````