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

# List contacts

> Returns a paginated list of contacts. A customer is limited to seven
contacts per organisation unit (or seven without an org unit).




## OpenAPI

````yaml GET /contacts/
openapi: 3.0.3
info:
  title: Piriod API
  version: 1.0.0
  description: >
    Piriod API for billing, payments, procurement and collections.


    All requests require:

    - `Authorization: Token <api_token>` header.

    - `x-simple-workspace: <workspace_id>` header (the account/workspace
    identifier).

    - Optionally `x-piriod-test-mode: true` to operate against test-mode data.


    See the Documentation tab for getting started, integration flows,
    authentication,

    error handling and pagination/filtering guides.
servers:
  - url: https://api.piriod.com
    description: Production
security:
  - TokenAuth: []
paths:
  /contacts/:
    get:
      tags:
        - Billing
      summary: List contacts
      description: |
        Returns a paginated list of contacts. A customer is limited to seven
        contacts per organisation unit (or seven without an org unit).
      parameters:
        - $ref: '#/components/parameters/WorkspaceHeader'
        - $ref: '#/components/parameters/TestModeHeader'
        - $ref: '#/components/parameters/PageQuery'
        - $ref: '#/components/parameters/PageSizeQuery'
        - $ref: '#/components/parameters/OrderingQuery'
        - name: customer
          in: query
          schema:
            type: string
        - name: orgunit
          in: query
          schema:
            type: string
        - name: name
          in: query
          schema:
            type: string
        - name: email
          in: query
          schema:
            type: string
        - name: invoicing
          in: query
          schema:
            type: boolean
        - name: collections
          in: query
          schema:
            type: boolean
        - name: expand
          in: query
          schema:
            type: string
          description: Pass `orgunit` to expand the orgunit relation inline.
      responses:
        '200':
          description: Paginated contact list.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Paginated'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/Contact'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    WorkspaceHeader:
      name: x-simple-workspace
      in: header
      required: true
      schema:
        type: string
      description: Workspace (account) identifier. Required for every request.
      example: acc_01H8XYZ123ABC
    TestModeHeader:
      name: x-piriod-test-mode
      in: header
      required: false
      schema:
        type: boolean
        default: false
      description: Whether to operate against test-mode data. Defaults to `false`.
    PageQuery:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number to retrieve (1-indexed).
    PageSizeQuery:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of items per page.
    OrderingQuery:
      name: ordering
      in: query
      required: false
      schema:
        type: string
      description: |
        Field to sort results by. Prefix with `-` for descending order
        (e.g. `-created`).
  schemas:
    Paginated:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          description: Total number of items matching the filter.
          example: 142
        next:
          type: string
          format: uri
          nullable: true
          description: URL of the next page, or `null` if last page.
        previous:
          type: string
          format: uri
          nullable: true
          description: URL of the previous page, or `null` if first page.
        results:
          type: array
          items: {}
          description: The items in the current page.
    Contact:
      type: object
      properties:
        id:
          type: string
          readOnly: true
          example: con_01H8XYZ123ABC
        customer:
          type: string
          nullable: true
          description: Customer ID this contact belongs to.
        orgunit:
          type: string
          nullable: true
          description: Organisation unit ID. Optional sub-grouping inside a customer.
        name:
          type: string
          maxLength: 64
        email:
          type: string
          format: email
        phone:
          type: string
          maxLength: 12
          nullable: true
        invoicing:
          type: boolean
          default: true
          description: Whether this contact receives invoice emails.
        collections:
          type: boolean
          default: true
          description: Whether this contact receives collection reminders.
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
      required:
        - name
        - email
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message.
      example:
        detail: Authentication credentials were not provided.
  responses:
    Unauthorized:
      description: Authentication credentials missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |
        Use header `Authorization: Token <api_token>`.
        API tokens are obtained from the Piriod dashboard.

````