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

# List your members and invitations

> Lists the members of your organisation and the invitations you have sent, with their
`roles` and their status: `pending`, `active`, `declined`, `expired` or `withdrawn`. A
member's `name` and `email` are shown only once they have accepted.

Live keys see test accounts too, marked `test: true`. Test keys see only test accounts.

Unknown query parameters are rejected with `422 validation_failed`.




## OpenAPI

````yaml GET /v1/members
openapi: 3.1.0
info:
  title: OSA Partner API
  version: 1.0.0
  summary: Send claims to adjusters in the OSA app and follow their acceptance.
  description: >
    The OSA Partner API lets a partner's claims system invite adjusters to its
    organisation,

    send them claims, and see whether each claim was accepted or rejected in the
    OSA app.


    **Conventions**

    - All requests and responses are JSON (`application/json`); errors use RFC
    9457 problem
      details (`application/problem+json`).
    - Field names are `snake_case`. Enum values are lowercase (for example
    `flood`,
      `pending_acceptance`), except US state and territory codes, which are the standard
      two-letter USPS codes, and flood zones, which are written as FEMA writes them (for
      example `AE`).
    - Enums are **open**: new values may be added to responses at any time, so
    your code must
      tolerate values it doesn't recognise.
    - Additive changes (new endpoints, new optional request fields, new response
    fields, new
      enum values) are made within `/v1`. Breaking changes go to a new version.
    - Requests are strict: an unknown or misspelled body field or query
    parameter is
      rejected with `422 validation_failed`, so typos can't be silently ignored.
    - Your own claim id (`external_id`) is stored on every claim and returned on
    every claim
      response, so you can match claims without keeping OSA's id.
    - Timestamps are RFC 3339 date-times in UTC. Dates that are calendar dates
    (such as the
      date of loss) are `YYYY-MM-DD` and are never converted between time zones.

    **Keys.** Every request except `GET /v1/health` needs an API key sent as

    `Authorization: Bearer <key>`. Live keys start with `osa_live_`; test keys
    start with

    `osa_test_` and only reach test claims and test accounts.
  contact:
    name: OSA API support
    email: info@osaconnection.com
    url: https://docs.osaconnection.com
servers:
  - url: https://api.osaconnection.com
    description: >-
      Production. Live and test keys both use this host; the key decides which
      data you reach.
security:
  - apiKey: []
tags:
  - name: Claims
    description: >
      Send claims to adjusters, offer them to another adjuster, and poll for
      acceptance.

      `/v1/claims` is always the claims you sent through the API.
  - name: Members
    description: >-
      Invite people to your organisation by their OSAID, with a role, and track
      their invitations.
  - name: Account
    description: Check which partner and permissions your API key carries.
  - name: Health
    description: Service availability. No key needed.
paths:
  /v1/members:
    get:
      tags:
        - Members
      summary: List your members and invitations
      description: >
        Lists the members of your organisation and the invitations you have
        sent, with their

        `roles` and their status: `pending`, `active`, `declined`, `expired` or
        `withdrawn`. A

        member's `name` and `email` are shown only once they have accepted.


        Live keys see test accounts too, marked `test: true`. Test keys see only
        test accounts.


        Unknown query parameters are rejected with `422 validation_failed`.
      operationId: listMembers
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: >-
            One page of members and invitations. `next_cursor` is `null` on the
            last page.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberList'
              examples:
                roster:
                  summary: An active adjuster, a pending invitation and a test account
                  value:
                    data:
                      - osa_id: Xk3pQ9vT2mN8rL5wB7yC1dF4gH6j
                        status: active
                        roles:
                          - adjuster
                        test: false
                        name: Jordan Ellis
                        email: jordan.ellis@example.com
                        invited_at: '2026-09-01T16:20:00Z'
                        expires_at: null
                        responded_at: '2026-09-01T18:44:12Z'
                        invited_as: Jordan Ellis
                        invited_by: Dana Whitfield, Claims Operations
                        purpose: Flood claims in the Tampa Bay area this season.
                        note: null
                      - osa_id: Hp2sK8dL4fJ6gA1zX9cV3bN7mQ5w
                        status: pending
                        roles:
                          - adjuster
                        test: false
                        name: null
                        email: null
                        invited_at: '2026-09-28T13:02:45Z'
                        expires_at: '2026-10-05T13:02:45Z'
                        responded_at: null
                        invited_as: Todd Rivera
                        invited_by: Dana Whitfield, Claims Operations
                        purpose: Flood claims in the Tampa Bay area this season.
                        note: Referred by Jordan Ellis.
                      - osa_id: Tz4xC7vB1nM9qW3eR6tY2uI8oP5a
                        status: active
                        roles:
                          - adjuster
                        test: true
                        name: Test Adjuster 1
                        email: test-adjuster-1@example.com
                        invited_at: '2026-08-30T10:00:00Z'
                        expires_at: null
                        responded_at: '2026-08-30T10:05:00Z'
                        invited_as: null
                        invited_by: null
                        purpose: null
                        note: null
                    next_cursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - apiKey:
            - members:read
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Page size. Defaults to 50; at most 200.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
      examples:
        max:
          summary: The largest page
          value: 200
    Cursor:
      name: cursor
      in: query
      required: false
      description: >
        The `next_cursor` from the previous page. Cursors are opaque; send the
        same filters with

        each cursor as with the first page.
      schema:
        type: string
        minLength: 1
        maxLength: 512
      examples:
        next:
          summary: Continue from the previous page
          value: eyJ0IjoiMjAyNi0wOS0yOFQxNToxMjowOVoiLCJpIjoiOWIyZTRmNzAifQ
  headers:
    RequestId:
      description: >
        The id of this request. Quote it to OSA support. On error responses it
        equals

        `request_id` in the body.
      required: true
      schema:
        type: string
      examples:
        request_id:
          summary: A request id
          value: 7f3e9a1c2b4d6e8f0a1b3c5d7e9f1a2b
    RetryAfter:
      description: Seconds to wait before retrying.
      required: true
      schema:
        type: integer
        minimum: 1
      examples:
        seconds:
          summary: Retry in 12 seconds
          value: 12
  schemas:
    MemberList:
      type: object
      description: One page of members and invitations.
      required:
        - data
        - next_cursor
      properties:
        data:
          type: array
          description: The members and invitations on this page.
          items:
            $ref: '#/components/schemas/Member'
        next_cursor:
          type:
            - string
            - 'null'
          description: Pass this as `cursor` to get the next page; `null` on the last page.
    Member:
      type: object
      description: A member of your organisation, or an invitation you sent.
      required:
        - osa_id
        - status
        - roles
        - test
        - name
        - email
        - invited_at
        - expires_at
        - responded_at
        - invited_as
        - invited_by
        - purpose
        - note
      properties:
        osa_id:
          type: string
          description: The person's OSAID.
        status:
          type: string
          description: >
            `pending`: invited, not yet answered. `active`: accepted and a
            member of your

            organisation. `declined`: the person declined. `expired`: not
            answered within 7 days.

            `withdrawn`: you withdrew the invitation. Open list: new values may
            be added; treat

            an unknown value as an unknown state.
          enum:
            - pending
            - active
            - declined
            - expired
            - withdrawn
        roles:
          type: array
          description: >
            The role kinds the person holds in your organisation; empty when
            none of their roles

            has a kind. These are OSA's role kinds, not your own titles for the
            roles.
          items:
            type: string
            description: >
              A role kind: `adjuster` today. Open list: new values may be added;
              treat an

              unknown value as a role you don't specifically handle.
            enum:
              - adjuster
        test:
          type: boolean
          description: '`true` for one of your OSA-created test accounts.'
        name:
          type:
            - string
            - 'null'
          description: The person's name; `null` until they accept.
        email:
          type:
            - string
            - 'null'
          description: The person's email; `null` until they accept.
        invited_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the invitation was sent; `null` for members added without an
            invitation record.
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When a pending invitation expires; `null` unless pending.
        responded_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the person accepted or declined; `null` otherwise.
        invited_as:
          type:
            - string
            - 'null'
          description: >
            Who you said you were inviting; `null` when not sent. This is your
            own note, so

            after acceptance it can differ from the account's real `name`.
        invited_by:
          type:
            - string
            - 'null'
          description: >-
            Who in your organisation sent the invitation, as you sent it; `null`
            when not sent.
        purpose:
          type:
            - string
            - 'null'
          description: What the invitation is for, as you sent it; `null` when not sent.
        note:
          type:
            - string
            - 'null'
          description: Your note on the invitation, as you sent it; `null` when not sent.
    Problem:
      type: object
      description: >
        An RFC 9457 problem details object. Match on `code`, which is stable;
        `title` and

        `detail` are for people and may change. Quote `request_id` when
        contacting support.
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
          description: A link to this error's documentation.
        title:
          type: string
          description: A short summary of the error.
        status:
          type: integer
          description: The HTTP status code.
        detail:
          type: string
          description: What went wrong in this request.
        code:
          type: string
          description: >
            The stable error code. `malformed_request` (400); `invalid_key`
            (401);

            `insufficient_scope`, `not_in_plan` (403); `not_found` (404);
            `duplicate_claim`,

            `claim_already_accepted`, `already_member`, `invitation_pending`
            (409);

            `payload_too_large` (413); `validation_failed`,
            `idempotency_key_reused`,

            `unknown_osaid`, `adjuster_not_a_member`, `adjuster_not_accepting`,

            `environment_mismatch` (422); `rate_limited` (429); `internal_error`
            (500). Open list:

            new values may be added; treat an unknown value as an error you
            don't specifically

            handle, by its HTTP `status`.
          enum:
            - malformed_request
            - invalid_key
            - insufficient_scope
            - not_in_plan
            - not_found
            - duplicate_claim
            - claim_already_accepted
            - already_member
            - invitation_pending
            - payload_too_large
            - validation_failed
            - idempotency_key_reused
            - unknown_osaid
            - adjuster_not_a_member
            - adjuster_not_accepting
            - environment_mismatch
            - rate_limited
            - internal_error
        request_id:
          type: string
          description: The id of this request. Quote it when contacting support.
        errors:
          type: array
          description: For `validation_failed`, each invalid field, parameter or header.
          items:
            type: object
            description: >-
              One problem. Exactly one of `pointer`, `parameter` or `header`
              says where.
            required:
              - detail
            properties:
              pointer:
                type: string
                description: >-
                  JSON Pointer to a body field, for example `/loss/date`. Empty
                  for the whole body.
              parameter:
                type: string
                description: The name of a query or path parameter, for example `limit`.
              header:
                type: string
                description: The name of a request header, for example `Idempotency-Key`.
              detail:
                type: string
                description: What is wrong with it.
        existing_claim_id:
          type: string
          format: uuid
          description: >-
            For `duplicate_claim`, the id of the claim that already exists.
            Always a claim your key can read.
        existing_claim_url:
          type: string
          format: uri
          description: >-
            For `duplicate_claim`, the API link to the claim that already
            exists. Always a claim your key can read.
  responses:
    Unauthorized:
      description: >
        The key is missing, malformed, unknown, revoked or expired
        (`invalid_key`).
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            invalid_key:
              summary: invalid_key
              value:
                type: https://docs.osaconnection.com/errors#invalid_key
                title: Invalid API key
                status: 401
                detail: The API key is missing, malformed, revoked or expired.
                code: invalid_key
                request_id: 7f3e9a1c2b4d6e8f0a1b3c5d7e9f1a2b
    Forbidden:
      description: >
        The key is valid but can't do this. `not_in_plan`: the operation is not
        included in your

        organisation's plan and add-ons, whatever the key's own permissions.
        `insufficient_scope`:

        your plan and add-ons include the operation, but the key doesn't have
        the permission it

        needs.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            insufficient_scope:
              summary: insufficient_scope
              value:
                type: https://docs.osaconnection.com/errors#insufficient_scope
                title: Insufficient scope
                status: 403
                detail: This key doesn't have the claims:write permission.
                code: insufficient_scope
                request_id: 0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e
            not_in_plan:
              summary: not_in_plan
              value:
                type: https://docs.osaconnection.com/errors#not_in_plan
                title: Not in plan
                status: 403
                detail: >-
                  Member invitations are not included in your organisation's
                  plan and add-ons.
                code: not_in_plan
                request_id: 1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f
    ValidationFailed:
      description: >
        The request is invalid (`validation_failed`): a missing, unknown or
        invalid body field,

        query parameter, path parameter or header. `errors` lists each problem:
        `pointer` for a

        body field, `parameter` for a query or path parameter, `header` for a
        header.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            validation_failed:
              summary: validation_failed
              value:
                type: https://docs.osaconnection.com/errors#validation_failed
                title: Validation failed
                status: 422
                detail: The request has 1 invalid field.
                code: validation_failed
                request_id: 8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a
                errors:
                  - parameter: limit
                    detail: must be <= 200
    RateLimited:
      description: >
        Too many requests for this key (`rate_limited`). Wait for the number of
        seconds in

        `Retry-After`, then retry.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            rate_limited:
              summary: rate_limited
              value:
                type: https://docs.osaconnection.com/errors#rate_limited
                title: Rate limited
                status: 429
                detail: This key has exceeded 300 requests per minute.
                code: rate_limited
                request_id: 9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f
    InternalError:
      description: >
        Something failed on OSA's side (`internal_error`). Retry with
        exponential backoff; for

        `POST` requests, reuse the same `Idempotency-Key`. If it persists,
        contact OSA with the

        `request_id`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            internal_error:
              summary: internal_error
              value:
                type: https://docs.osaconnection.com/errors#internal_error
                title: Internal error
                status: 500
                detail: Something went wrong on our side. Retry later.
                code: internal_error
                request_id: 2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: osa_live_… or osa_test_…
      description: >
        Send your API key as a bearer token: `Authorization: Bearer osa_live_…`.

        Keys are opaque; each belongs to exactly one partner. Keys starting with
        `osa_test_`

        reach only test claims and test accounts. The scopes listed on each
        operation are the

        permissions the key needs. A key's permissions are set when it is issued
        and can be

        changed by OSA on request, never beyond what your plan and add-ons
        include.

        `GET /v1/me` always shows the current set.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.