Skip to main content

Retrieve series information

GET 
/api/v1/series

Retrieves series metadata for the authenticated account. The endpoint supports three operation modes:

1. List All Series: Returns a complete list of all series associated with the authenticated account.

  • Omit the series parameter.
  • Response contains an array of all series with their metadata.

2. Get Specific Series: Returns metadata for a specified series if it exists in the account.

  • Provide the series parameter with a valid series identifier.
  • Response contains a single series object with name and displayName.

3. Non-Existent Series: When an invalid or non-existent series identifier is provided, the endpoint returns an empty list with HTTP 200 status.

  • Provide the series parameter with an invalid identifier.
  • Response contains an empty array.
  • This is not treated as an error condition; the endpoint always returns HTTP 200.

Use Cases:

  • Series Discovery: Browse all available series in an account
  • Series Validation: Verify if a specific series exists in an account
  • Metadata Retrieval: Get display names and identifiers for series management

Examples:

List All Series:

curl -L 'https://sandbox.amuselabs.com/pmm/api/v1/series' \
-H 'Authorization: Bearer YOUR_JWT_TOKEN' \
-H 'Accept: application/json'

Get Specific Series:

curl -L 'https://sandbox.amuselabs.com/pmm/api/v1/series?series=api-demo-crossword' \
-H 'Authorization: Bearer YOUR_JWT_TOKEN' \
-H 'Accept: application/json'

Request​

Responses​

Successful response. The endpoint always returns HTTP 200 status code. The response body contains a list of series objects. When the series parameter is omitted, the list contains all series for the account. When a valid series identifier is provided, the list contains a single series object. When an invalid series identifier is provided, the list is empty.