> ## Documentation Index > Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt > Use this file to discover all available pages before exploring further. # Get All Warehouses > Returns all Warehouses for the WMS connection associated with the provided access token. ## OpenAPI ````yaml get /wms/warehouses openapi: 3.1.0 info: description: > Trackstar is a Unified API that provides standard endpoints for Supply Chain Logistics. We currently offer an API for Warehouse Management Systems (WMS). title: Trackstar API version: 0.1.0 servers: - description: Trackstar API url: https://production.trackstarhq.com security: [] tags: [] externalDocs: description: Trackstar API Documentation url: https://docs.trackstarhq.com paths: /wms/warehouses: get: tags: - wms - Warehouses summary: Get All Warehouses description: >- Returns all Warehouses for the WMS connection associated with the provided access token. operationId: get_wms_get_warehouses parameters: - in: header name: x-trackstar-api-key description: Your organization-level Trackstar API key. schema: type: string example: required: true - in: header name: x-trackstar-access-token description: >- Your user's access token for a specific integration (ShipHero, Extensiv, etc). schema: type: string example: required: true - in: query name: page_token description: >- The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages. schema: type: - string - 'null' example: page_token required: false - in: query name: limit description: The maximum number of items to return. The default is 1000. schema: type: integer minimum: 1 maximum: 1000 example: 1000 required: false - in: query name: ids schema: $ref: '#/components/schemas/WmsWarehouseIdsQueryParam' required: false style: deepObject explode: true - in: query name: created_date description: >- Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send `created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z.` See the [filtering docs](/how-to-guides/about-the-api#filtering) for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of `gte`/`lte` than it is to use `gt`/`lt`. schema: $ref: '#/components/schemas/WmsWarehouseCreated_DateQueryParam' required: false style: deepObject explode: true - in: query name: updated_date description: Same syntax as `created_date`. schema: $ref: '#/components/schemas/WmsWarehouseUpdated_DateQueryParam' required: false style: deepObject explode: true - in: query name: trackstar_created_date description: Same syntax as `created_date`. schema: $ref: '#/components/schemas/WmsWarehouseTrackstar_Created_DateQueryParam' required: false style: deepObject explode: true - in: query name: trackstar_updated_date description: Same syntax as `created_date`. schema: $ref: '#/components/schemas/WmsWarehouseTrackstar_Updated_DateQueryParam' required: false style: deepObject explode: true - in: query name: trackstar_tags description: >- Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings. schema: $ref: '#/components/schemas/WmsWarehouseTrackstar_Tags_FlatQueryParam' required: false style: deepObject explode: true - in: query name: name description: The name of the warehouse. schema: $ref: '#/components/schemas/WmsWarehouseNameQueryParam' required: false style: deepObject explode: true - in: query name: code description: The warehouse code. schema: $ref: '#/components/schemas/WmsWarehouseCodeQueryParam' required: false style: deepObject explode: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WmsWarehousesListEndpoint' description: Successful response '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: Validation error components: schemas: WmsWarehouseIdsQueryParam: type: object properties: in: type: array description: >- A comma-separated list of resource IDs. If provided, all other query params are ignored. example: resource_id_1,resource_id_2 items: type: string description: '' required: - in additionalProperties: false title: WmsWarehouseIdsQueryParam WmsWarehouseCreated_DateQueryParam: type: object properties: eq: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' neq: type: string format: date-time description: '' in: type: array description: Comma-separated. items: type: string format: date-time description: '' nin: type: array description: Comma-separated. items: type: string format: date-time description: '' gt: type: string format: date-time description: '' gte: type: string format: date-time description: '' lt: type: string format: date-time description: '' lte: type: string format: date-time description: '' additionalProperties: false title: WmsWarehouseCreated_DateQueryParam WmsWarehouseUpdated_DateQueryParam: type: object properties: eq: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' neq: type: string format: date-time description: '' in: type: array description: Comma-separated. items: type: string format: date-time description: '' nin: type: array description: Comma-separated. items: type: string format: date-time description: '' gt: type: string format: date-time description: '' gte: type: string format: date-time description: '' lt: type: string format: date-time description: '' lte: type: string format: date-time description: '' additionalProperties: false title: WmsWarehouseUpdated_DateQueryParam WmsWarehouseTrackstar_Created_DateQueryParam: type: object properties: eq: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' neq: type: string format: date-time description: '' in: type: array description: Comma-separated. items: type: string format: date-time description: '' nin: type: array description: Comma-separated. items: type: string format: date-time description: '' gt: type: string format: date-time description: '' gte: type: string format: date-time description: '' lt: type: string format: date-time description: '' lte: type: string format: date-time description: '' additionalProperties: false title: WmsWarehouseTrackstar_Created_DateQueryParam WmsWarehouseTrackstar_Updated_DateQueryParam: type: object properties: eq: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' neq: type: string format: date-time description: '' in: type: array description: Comma-separated. items: type: string format: date-time description: '' nin: type: array description: Comma-separated. items: type: string format: date-time description: '' gt: type: string format: date-time description: '' gte: type: string format: date-time description: '' lt: type: string format: date-time description: '' lte: type: string format: date-time description: '' additionalProperties: false title: WmsWarehouseTrackstar_Updated_DateQueryParam WmsWarehouseTrackstar_Tags_FlatQueryParam: type: object properties: contains: type: array description: Comma-separated. example: tag_1,tag_2:value_2 items: type: string description: '' not_contains: type: array description: Comma-separated. items: type: string description: '' additionalProperties: false title: WmsWarehouseTrackstar_Tags_FlatQueryParam WmsWarehouseNameQueryParam: type: object properties: eq: type: string description: '' example: Bethlehem (PA) neq: type: string description: '' in: type: array description: Comma-separated. items: type: string description: '' nin: type: array description: Comma-separated. items: type: string description: '' contains: type: string description: '' not_contains: type: string description: '' additionalProperties: false title: WmsWarehouseNameQueryParam WmsWarehouseCodeQueryParam: type: object properties: eq: type: string description: '' example: ABE-1 neq: type: string description: '' in: type: array description: Comma-separated. items: type: string description: '' nin: type: array description: Comma-separated. items: type: string description: '' contains: type: string description: '' not_contains: type: string description: '' additionalProperties: false title: WmsWarehouseCodeQueryParam WmsWarehousesListEndpoint: type: object properties: data: type: array description: '' items: $ref: '#/components/schemas/WmsWarehouseApiItemSchema' next_token: type: - string - 'null' description: >- See [pagination](/how-to-guides/about-the-api#pagination) for more details. example: next_token total_count: type: integer description: The number of items returned. example: 1 required: - data - next_token - total_count additionalProperties: false title: WmsWarehousesListEndpoint ValidationError: properties: error: type: string detail: type: object properties: : type: object properties: : type: array items: type: string required: - error type: object title: ValidationError WmsWarehouseApiItemSchema: type: object properties: id: type: string description: The unique ID of the warehouse. example: warehouse_id created_date: type: string format: date-time description: The date the warehouse was created. example: '2022-01-01T00:00:00Z' updated_date: type: string format: date-time description: The date the warehouse was last updated. example: '2022-01-02T05:05:05Z' name: type: string description: The name of the warehouse. example: Bethlehem (PA) code: type: - string - 'null' description: The warehouse code. example: ABE-1 address: $ref: '#/components/schemas/ShipFromAddress' trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} additional_fields: type: object description: Integration-specific fields example: key: value additionalProperties: {} trackstar_created_date: type: string format: date-time description: '' trackstar_updated_date: type: string format: date-time description: '' required: - additional_fields - address - code - created_date - id - name - trackstar_created_date - trackstar_tags - trackstar_updated_date - updated_date additionalProperties: false title: WmsWarehouseApiItemSchema ShipFromAddress: type: object properties: address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States required: - address1 - address2 - address3 - city - country - postal_code - state additionalProperties: false title: ShipFromAddress ````