> ## 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 > Retrieve information about all pickups which have been created from your account. **API v2 is entering maintenance mode.** New users should start with API v3 to access our latest features and improved performance. Already using v2? Don't worry, your current integration remains fully functional. Read more about [maintenance mode](/docs/getting-started/api-version-guide), or check out the [migration guide for API v3](/docs/getting-started/migration-guidelines-for-api-v3). This is limited to the carriers which 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/v2/pickups/openapi.yaml get /pickups openapi: 3.1.0 info: title: Pickups version: 2.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/v2 description: Sendcloud Production security: [] tags: - name: Pickups description: >- A pickup is a arrangement with a carrier in which they agree to pick up parcels at a given address at a given moment. They will bring those parcels to the sorting center. paths: /pickups: get: tags: - Pickups summary: Retrieve a list of pickups description: >- Retrieve information about all pickups which have been created from your account. operationId: sc-public-v2-scp-get-all_pickups parameters: - schema: type: integer minimum: 1 in: query name: limit description: Amount of pickups that will be shown per page. responses: '200': description: OK content: application/json: schema: type: object properties: next: type: string description: Url to retrieve the next page of pickups. nullable: true previous: type: string description: Url to retrieve the previous page of pickups. nullable: true pickups: type: array items: $ref: '#/components/schemas/PickupList' examples: RetrieveDHLExpressPickups: summary: Retrieve a list of DHL Express pickups value: next: null previous: null pickups: - id: 1 pickup_from: '2022-04-06T12:00:00Z' pickup_until: '2022-04-06T17:00:00Z' country: NL carrier: dhl_express tracking_number: PRG220406003404 pickup_status: Cancelled created_at: '2022-03-30T10:57:02.344479Z' cancelled_at: '2022-03-30T10:57:11.656260Z' - id: 2 pickup_from: '2022-04-06T12:00:00Z' pickup_until: '2022-04-06T17:00:00Z' country: NL carrier: dhl_express tracking_number: PRG220406002044 pickup_status: Cancelled created_at: '2022-03-30T09:20:37.957495Z' cancelled_at: '2022-03-30T09:20:45.433367Z' RetrieveFedexPickups: summary: Retrieve a list of Fedex Express pickups value: next: null previous: null pickups: - id: 1 pickup_from: '2022-11-11T10:53:43.533832Z' pickup_until: '2022-11-11T12:53:43.533832Z' country: ES carrier: fedex tracking_number: '' pickup_status: Announcing created_at: '2022-11-10T10:05:02.185445Z' cancelled_at: null - id: 2 pickup_from: '2022-11-11T10:53:43.533832Z' pickup_until: '2022-11-11T12:53:43.533832Z' country: ES carrier: fedex tracking_number: '791043498202211103183' pickup_status: Created created_at: '2022-11-10T10:05:02.185445Z' cancelled_at: null RetrieveCorreosExpressPickups: summary: Retrieve a list of Correos Express pickups value: next: null previous: null pickups: - id: 2 pickup_from: '2022-11-26T11:00:00Z' pickup_until: '2022-11-26T14:00:00Z' country: ES carrier: correos_express tracking_number: '100113932' pickup_status: Cancelled created_at: '2022-11-25T13:15:18.160521Z' cancelled_at: '2022-11-25T13:17:14.476858Z' contract: 57 - id: 1 pickup_from: '2022-11-26T11:00:00Z' pickup_until: '2022-11-26T15:00:00Z' country: ES carrier: correos_express tracking_number: '100113931' pickup_status: Cancelled created_at: '2022-11-25T12:53:21.938565Z' cancelled_at: '2022-11-25T12:55:23.543111Z' contract: 57 RetrieveDHLPickups: summary: Retrieve a list of DHL pickups value: next: null previous: null pickups: - id: 2 pickup_from: '2022-12-14T11:00:00Z' pickup_until: '2022-12-14T14:00:00Z' country: NL carrier: dhl tracking_number: 05931316-DF19B800 pickup_status: Created created_at: '2022-12-13T12:11:21.160521Z' cancelled_at: null contract: 8 - id: 1 pickup_from: '2022-12-15T11:00:00Z' pickup_until: '2022-12-15T14:00:00Z' country: NL carrier: dhl tracking_number: 05931316-DBEA8B58 pickup_status: Created created_at: '2022-12-13T13:15:18.160521Z' cancelled_at: null contract: 8 RetrieveDPDPickups: summary: Retrieve a list of DPD pickups value: next: null previous: null pickups: - id: 2 pickup_from: '2022-11-26T11:00:00Z' pickup_until: '2022-11-26T14:00:00Z' country: DE carrier: dpd tracking_number: '09985053927752' pickup_status: Created created_at: '2022-11-25T13:15:18.160521Z' cancelled_at: '2022-11-25T13:17:14.476858Z' contract: 14 - id: 1 pickup_from: '2022-10-26T11:00:00Z' pickup_until: '2022-10-26T15:00:00Z' country: DE carrier: dpd tracking_number: '09985053927753' pickup_status: Created created_at: '2022-10-25T12:53:21.938565Z' cancelled_at: null contract: 14 RetrievePosteITDeliveryPickups: summary: Retrieve a list of Poste Italiane Delivery pickups value: next: null previous: null pickups: - id: 2 pickup_from: '2023-01-03T11:00:00Z' pickup_until: '2023-01-03T14:00:00Z' country: IT carrier: poste_it_delivery tracking_number: '09985053927752' pickup_status: Created created_at: '2022-12-29T13:15:18.160521Z' cancelled_at: '2022-12-30T13:17:14.476858Z' contract: 6 - id: 1 pickup_from: '2023-01-02T11:00:00Z' pickup_until: '2023-01-02T14:00:00Z' country: IT carrier: poste_it_delivery tracking_number: '09985053927753' pickup_status: Created created_at: '2022-12-28T12:53:21.938565Z' cancelled_at: null contract: 6 RetrieveCorreosPickups: summary: Retrieve a list of Correos pickups value: next: null previous: null pickups: - id: 2 pickup_from: '2022-12-09T11:00:00Z' pickup_until: '2022-12-09T14:00:00Z' country: ES carrier: correos tracking_number: SR2022120795420EG pickup_status: Cancelled created_at: '2022-12-07T14:27:45.114186Z' cancelled_at: '2022-12-07T14:30:21.711420Z' contract: 1 - id: 1 pickup_from: '2022-12-09T11:00:00Z' pickup_until: '2022-12-09T14:00:00Z' country: ES carrier: correos tracking_number: SR2022120794694EG pickup_status: Cancelled created_at: '2022-12-07T14:24:25.114186Z' cancelled_at: '2022-12-07T14:26:12.213786Z' contract: 1 RetrieveUPSPickups: summary: Retrieve a list of UPS pickups value: next: null previous: null pickups: - id: 2 pickup_from: '2023-01-19T13:12:53.992000Z' pickup_until: '2023-01-19T15:12:53.992000Z' country: ES carrier: ups tracking_number: 29QECLQO4D8 pickup_status: Cancelled created_at: '2023-01-18T08:28:41.987180Z' cancelled_at: '2023-01-18T08:58:44.509553Z' contract: 33 - id: 1 pickup_from: '2023-01-19T07:00:00Z' pickup_until: '2023-01-19T15:00:00Z' country: ES carrier: ups tracking_number: 29GECMOG1P4 pickup_status: Cancelled created_at: '2023-01-18T08:16:56.761459Z' cancelled_at: '2023-01-18T08:47:00.306231Z' contract: 33 RetrieveDHLParcelIberiaPickups: summary: Retrieve a list of DHL Parcel Iberia pickups value: next: null previous: null pickups: - id: 1 pickup_from: '2023-02-03T11:00:00Z' pickup_until: '2023-02-03T14:00:00Z' country: ES carrier: dhl_parcel_iberia tracking_number: '1785.0' pickup_status: Created created_at: '2023-01-29T13:15:18.160521Z' cancelled_at: null contract: 6 - id: 2 pickup_from: '2023-02-14T11:00:00Z' pickup_until: '2023-02-14T14:00:00Z' country: ES carrier: dhl_parcel_iberia tracking_number: '09985053927753' pickup_status: Created created_at: '2023-02-08T12:53:21.938565Z' cancelled_at: null contract: 6 FailedPickups: summary: Retrieve a list of failed pickups value: next: >- https://panel.sendcloud.sc/api/v2/pickups/?cursor=cD0yOTQzNDQ%3D&limit=1 previous: null pickups: - id: 1 pickup_from: '2021-04-06T12:00:00Z' pickup_until: '2021-04-06T17:00:00Z' country: NL carrier: dhl_express tracking_number: '' pickup_status: Failed created_at: '2022-03-30T10:58:09.832504Z' cancelled_at: null security: - HTTPBasicAuth: [] - OAuth2ClientCreds: [] components: schemas: PickupList: title: Pickup Object (List Item) description: A Sendcloud pickup object (returned through a list). type: object properties: id: type: integer format: int64 minimum: 1 description: Unique identifier of the pickup. carrier: type: string minLength: 1 country: minLength: 2 maxLength: 2 example: NL description: ISO 3166-1 alpha-2 country code. enum: - NL - DE - ES - FR - IT - AT type: string tracking_number: type: string minLength: 0 nullable: true pickup_from: type: string minLength: 1 format: date-time description: ISO 8601 DateTime when the pickup should take place. pickup_until: type: string minLength: 1 format: date-time description: >- ISO 8601 DateTime of the pickup location close time. This could be useful in case the pickup is delayed. nullable: true pickup_status: type: string enum: - Created - Cancelled - Failed - Announcing created_at: type: string minLength: 1 format: date-time description: ISO 8601 DateTime at which the pickup is created. cancelled_at: type: string minLength: 1 format: date-time description: ISO 8601 DateTime at which the pickup is cancelled. nullable: true contract: type: integer description: Id of the contract that is used to create the pickup. required: - id - carrier - country - pickup_from - pickup_status - created_at - cancelled_at 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. ````