# Pims API

> Pims API on Apizie: 28 endpoints (Find all categories, Get one category by ID, Find all channels, Get one channel by ID, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/ecommerce:pims/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:pims`
- Category: E-commerce
- Status: byok
- Source: https://pims.io
- Page: https://apizie.tech/api/ecommerce/pims
- OpenAPI: https://apizie.tech/api/ecommerce/pims/openapi.json

Hereafter is the documentation of the private API of [Pims: Pointages Intelligents pour le Monde du Spectacle](https://pims.io). This API is designed for 3rd-party softwares, editors and partners. Its main purpose is…

## Endpoints

### Find all categories
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| label | string | no | Find only the categories whose label/short label contains this value. |
| show_ignored | boolean | no | If set to `false`, show only the categories which are not ignored. If set to `true`, show all categories. |
| sort | string | no | Sort the categories in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Get one category by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| category_id | integer | yes | ID of the targeted category. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all channels
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| label | string | no | Find only the channels whose label contains this value. |
| show_ignored | boolean | no | If set to `false`, show only the channels which are not ignored. If set to `true`, show all channels. |
| sort | string | no | Sort the channels in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Get one channel by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| channel_id | integer | yes | ID of the targeted channel. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all events
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| label | string | no | Find only the events whose label contains this value. |
| from_datetime | string | no | Find only the events starting after this date. |
| to_datetime | string | no | Find only the events starting before this date. |
| city | string | no | Find only the events whose venue city (or metropolitan area) contains this value. |
| sort | string | no | Sort the events in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Get one event by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all capacities for one event
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-events-capacities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]categories which are not ignored. If set to `true`, show everything. |
| sort | string | no | Sort the capacities in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |

### Get one capacity by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-event-capacity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| capacity_id | integer | yes | ID of the targeted capacity. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]categories which are not ignored. If set to `true`, show everything. |

### Find all categories for one event
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-events-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]categories/[event-]price ranges which are not ignored. If set to `true`, show everything. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |

### Get one event category by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-event-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| category_id | number | yes | ID of the targeted event category. |
| show_ignored | boolean | no | If set to `false`, show only the embedded [event-]price ranges which are not ignored. If set to `true`, show everything. |

### Find all channels for one event
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-events-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]channels which are not ignored. If set to `true`, show everything. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |

### Get one event channel by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-event-channel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| channel_id | integer | yes | ID of the targeted event channel. |

### Find all promotions for one event
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-events-promotions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| label | string | no | Find only the promotions whose label contains this value. |
| from_date | string | no | Find only the promotions starting after this date. |
| to_date | string | no | Find only the promotions ending before this date. |
| type | string | no | Find only the promotions whose type is equal to this value. |
| family | string | no | Find only the promotions whose family is equal to this value. |
| sort | string | no | Sort the promotions in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all ticket counts for one event
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-ticket-counts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| from_date | string | no | Find only the ticket counts after this date. |
| to_date | string | no | Find only the ticket counts before this date. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to `true`, show… |
| show_not_approved | boolean | no | If set to `false`, show only the approved ticket counts. If set to `true`, show all the ticket counts. |
| sort | string | no | Sort the ticket counts in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |

### Find all detailed ticket counts for one event
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-detailed-ticket-counts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| from_date | string | no | Find only the ticket counts after this date. |
| to_date | string | no | Find only the ticket counts before this date. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to `true`, show… |
| show_not_approved | boolean | no | If set to `false`, show only the approved ticket counts. If set to `true`, show all the ticket counts. |
| sort | string | no | Sort the ticket counts in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |

### Get one detailed ticket count by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-detailed-ticket-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| ticket_count_id | integer | yes | ID of the targeted ticket count. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to `true`, show… |

### Get one ticket count by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-ticket-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| event_id | integer | yes | ID of the targeted event. |
| ticket_count_id | integer | yes | ID of the targeted ticket count. |
| show_ignored | boolean | no | If set to `false`, show only the [event-]categories/[event-]price ranges/[event]channels which are not ignored. If set to `true`, show… |

### Find all price ranges
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-price-ranges` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| label | string | no | Find only the price ranges whose label contains this value. |
| show_ignored | boolean | no | If set to `false`, show only the price ranges which are not ignored. If set to `true`, show all price ranges. |
| sort | string | no | Sort the price ranges in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Get one price range by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-price-range` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| price_range_id | integer | yes | ID of the targeted price range. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all promotions
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-promotions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| label | string | no | Find only the promotions whose label contains this value. |
| from_date | string | no | Find only the promotions starting after this date. |
| to_date | string | no | Find only the promotions ending before this date. |
| type | string | no | Find only the promotions whose type is equal to this value. |
| family | string | no | Find only the promotions whose family is equal to this value. |
| sort | string | no | Sort the promotions in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Get one promotion by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-promotion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| promotion_id | integer | yes | ID of the targeted promotion. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all series
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-series` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| label | string | no | Find only the venues whose label contains this value. |
| from_date | string | no | Find only the series starting after this date. |
| to_date | string | no | Find only the series ending before this date. |
| type | string | no | Find only the series whose type is equal to this value. |
| sort | string | no | Sort the series in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Get one series by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-series` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| series_id | integer | yes | ID of the targeted series. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all events for one series
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-series-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| series_id | integer | yes | ID of the targeted series. |
| from_datetime | string | no | Find only the events starting after this date. |
| to_datetime | string | no | Find only the events starting before this date. |
| city | string | no | Find only the events whose venue city (or metropolitan area) contains this value. |
| sort | string | no | Sort the events in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all promotions for one series
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-series-promotions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| series_id | integer | yes | ID of the targeted series. |
| label | string | no | Find only the promotions whose label contains this value. |
| from_date | string | no | Find only the promotions starting after this date. |
| to_date | string | no | Find only the promotions ending before this date. |
| type | string | no | Find only the promotions whose type is equal to this value. |
| family | string | no | Find only the promotions whose family is equal to this value. |
| sort | string | no | Sort the promotions in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all venues
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-venues` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| label | string | no | Find only the venues whose label contains this value. |
| city | string | no | Find only the venues whose city contains this value. |
| country_code | string | no | Find only the venues whose country_code is equal to this value. |
| type | string | no | Find only the venues whose type is equal to this value. |
| sort | string | no | Sort the venues in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Get one venue by ID
`GET https://apizie.tech/v1/ecommerce:pims/fetch-one-venue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| venue_id | integer | yes | ID of the targeted venue. |
| Accept-Language | string | no | Language used for the translatable labels. |

### Find all events for one venue
`GET https://apizie.tech/v1/ecommerce:pims/fetch-all-venues-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| venue_id | integer | yes | ID of the targeted venue. |
| from_datetime | string | no | Find only the events starting after this date. |
| to_datetime | string | no | Find only the events starting before this date. |
| city | string | no | Find only the events whose venue city (or metropolitan area) contains this value. |
| sort | string | no | Sort the events in the corresponding order. |
| page_size | integer | no | Pagination size, i.e. maximum number of items to be displayed in the response. |
| Accept-Language | string | no | Language used for the translatable labels. |

## Example
```
curl "https://apizie.tech/v1/ecommerce:pims/fetch-all-categories" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Pims API?
Create a free Apizie key, then send GET https://apizie.tech/v1/ecommerce:pims/fetch-all-categories with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Pims API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Pims itself also needs your own key from pims.io.

### Can AI agents use the Pims API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:pims.

### What is the status of the Pims API?
Needs your own provider key (bring your own key)