> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alvys.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List reference definitions

> List tenant custom reference definitions visible to the Public API for loads and stops, including type, allowed list values, and which entities each definition applies to.

Returns the catalog of custom reference definitions your tenant exposes to the Public API. Use this before creating a catalog-backed reference so you have the definition `Id`, `Type`, and allowed `Values`.

Only definitions marked visible to the Public API are returned. The response is an object keyed by entity name (`Load`, `Stop`, …).

Each requested `entities` value requires its matching read scope: `load:read` for `Load`, `stop:read` for `Stop`. Requesting both requires both scopes.

### Query parameters

| Name | Type | Required | Description |
| - | - | - | - |
| entities | string\[] | No | One or more entity kinds to include. Common values: `Load`, `Stop`. |
| version | string | Yes | API version in the path (for example `2.0`). |

### Example

```bash theme={null}
curl --location 'https://integrations.alvys.com/api/p/v2.0/references?entities=Load&entities=Stop' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

### Response shape

```json theme={null}
{
  "Load": [
    {
      "Id": "tenant-reference-id",
      "Name": "Customer PO",
      "CanBeAppliedTo": ["Load"],
      "Type": "Text",
      "Values": null,
      "Description": "Customer-provided purchase order"
    }
  ],
  "Stop": []
}
```

### Status codes

| Code | Description |
| - | - |
| 200 | Catalog returned for the requested entities. |
| 400 | Invalid validation failed. |
| 401 | Authentication failed or the token is missing. |
| 403 | The token lacks the required read scope(s). |


## OpenAPI

````yaml GET /api/p/v{version}/references
openapi: 3.0.1
info:
  title: Alvys
  description: >-
    Alvys provides a robust set of REST APIs to allow you to integrate Alvys
    into virtually any platform. These APIs cover most of Alvys' major product
    areas with additional endpoints being added regularly based on customer
    requests.
  contact:
    name: Alvys Support
    url: https://www.alvys.com/resources/contact/
  version: v1
servers:
  - url: https://integrations.alvys.com
    description: Public API Server
  - url: https://api.alvys.com/
    description: Public API Server
security:
  - Public: []
tags:
  - name: Authentication
    description: Obtain an OAuth 2.0 access token for the Alvys Public API.
  - name: Carrier Settlement Statements
    description: >-
      Search carrier settlement statements and retrieve a single statement by
      number.
  - name: Carriers
    description: Read carrier records, search carriers, and manage carrier documents.
  - name: Customers
    description: Create, read, update, delete, and search customer records.
  - name: Deductions
    description: >-
      Create one-time deductions and search or delete existing deduction
      records.
  - name: DispatchPreferences
    description: Dispatch preferences endpoints for reading dispatch rules and preferences.
  - name: Driver Settlement Statements
    description: >-
      Search driver settlement statements and retrieve a single statement by
      number.
  - name: Drivers
    description: >-
      Read driver records, search drivers and driver events, and manage driver
      documents.
  - name: Fuel
    description: Read and search fuel transactions.
  - name: Invoices
    description: >-
      Read invoices, create carrier invoices, and record carrier and customer
      payments.
  - name: Loads
    description: >-
      Read, update, and search loads; manage load documents, notes, and custom
      references.
  - name: Locations
    description: Read and search company location details.
  - name: Maintenance
    description: Read and search maintenance records.
  - name: References
    description: >-
      List tenant custom reference definitions and create or update values on
      existing loads and stops.
  - name: Subsidiaries
    description: >-
      List your company's subsidiaries and read a single subsidiary, so an
      integration can resolve a subsidiary id to a recognizable name.
  - name: Tenders
    description: Create, accept, reject, cancel, update, and search inbound EDI tenders.
  - name: Tolls
    description: Read and search toll transactions.
  - name: Tracking
    description: >-
      Record an asset's current location or telemetry from a third-party source,
      such as an external ELD or a self-reporting vehicle.
  - name: Trailers
    description: Read trailers, search trailer events, and manage trailer documents.
  - name: Trips
    description: >-
      Read and search trips; manage trip documents, stop appointments, arrivals,
      departures, and stop custom references.
  - name: Trucks
    description: Read trucks, search truck events, and manage truck documents.
  - name: Users
    description: List and search users.
  - name: Visibility
    description: >-
      Read inbound and outbound visibility history and search outbound
      visibility errors.
  - name: Webhooks
    description: >-
      Create, read, update, delete, enable, disable, verify, test, and rotate
      secrets for webhook subscriptions; read event types, delivery logs, and
      health metrics.
  - name: Accessorials
  - name: Credits
paths:
  /api/p/v{version}/references:
    get:
      tags:
        - References
      summary: List custom reference definitions
      description: >-
        Returns tenant custom reference definitions visible to the Public API,
        keyed by entity (`Load`, `Stop`, …). Pass one or more `entities` query
        values. Each requested entity requires its matching read scope
        (`load:read` for `Load`, `stop:read` for `Stop`); requesting both
        requires both scopes.
      parameters:
        - name: entities
          in: query
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ReferenceEntity'
        - name: version
          in: path
          description: API version (e.g., 2.0)
          required: true
          schema:
            type: string
            default: '2.0'
            example: '2.0'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/Alvys.Models.References.TenantReferenceCatalogResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
      security:
        - Public: []
components:
  schemas:
    ReferenceEntity:
      enum:
        - Stop
        - Load
        - Trip
        - Driver
        - Truck
        - Trailer
        - Customer
        - Location
      type: string
    Alvys.Models.References.TenantReferenceCatalogResponse:
      required:
        - CanBeAppliedTo
        - Id
        - Name
        - Type
      type: object
      properties:
        Id:
          type: string
        Name:
          type: string
        CanBeAppliedTo:
          type: array
          items:
            type: string
        Type:
          type: string
        Values:
          type: array
          items:
            type: string
          nullable: true
        Description:
          type: string
          nullable: true
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ValidationProblemDetails:
      required:
        - Errors
      type: object
      properties:
        Errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        Type:
          type: string
          nullable: true
        Title:
          type: string
          nullable: true
        Status:
          type: integer
          format: int32
          nullable: true
        Detail:
          type: string
          nullable: true
        Instance:
          type: string
          nullable: true
      additionalProperties: {}
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        Type:
          type: string
          nullable: true
        Title:
          type: string
          nullable: true
        Status:
          type: integer
          format: int32
          nullable: true
        Detail:
          type: string
          nullable: true
        Instance:
          type: string
          nullable: true
      additionalProperties: {}
  securitySchemes:
    Public:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        OAuth 2.0 client-credentials access token. Obtain one from
        https://auth.alvys.com/oauth/token (grant_type=client_credentials,
        audience=https://api.alvys.com/public/), then paste it here. The
        playground sends it as `Authorization: Bearer <token>`.

````