---
title: "Get invitations matching a criteria"
method: GET
path: "/services/invitation/v1/invitations"
tags: ["Invitations"]
---

# Get invitations matching a criteria

`GET /services/invitation/v1/invitations`

## Request

- Base URL: `https://na12.api.project44.com`
- URL: `https://na12.api.project44.com/services/invitation/v1/invitations`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/v4/oauth2/token`
- TypeScript: <https://skmtc.dev/project44/apis/project44-rest-api/docs/services/invitation/v1/invitations/get.ts> (a function with typed inputs; its response is checked against the schema)

Get invitations request allows users to fetch a list of invitations sent to entities to join your network. This request is useful for monitoring the status of the invitations and understanding the relationships formed within the network. By providing specific query parameters, users can filter the results based on the invitee's identifier type, value, and the capability for which the invitations were created.

## Query parameters

- `inviteeIdentifier.type` 'VAT' | 'SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU'
- `inviteeIdentifier.value` string
- `capability` 'TRUCKLOAD_ASSET_TRACKING'
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Paginated list of invitations matching the criteria

- InvitationPage
  - `paginationInfo` PaginationInfo: Pagination information about a collection of resources.
    - `pageNumber` integer: Matching page number given the supplied PaginationParameters.
    - `pageSize` integer: Page size matching the PaginationParameters.
    - `total` integer: Total number of resource items matching the supplied criteria.
  - `results` Invitation[]: List of invitations
    - `capability` 'TRUCKLOAD_ASSET_TRACKING': The capability which the invitation will provide.
    - `createdDateTime` string, date-time: The datetime when the invitation was created, in ISO-8601 format.
    - `invitee` Invitee: The entity being invited to provide the capability.
      - `contacts` InvitationContact[]: Contact details of the invitee.
        - `email` string: The email address of the contact.
        - `familyName` string: The family name of the contact (surname, lastname).
        - `givenName` string: The given name of the contact (name, firstname).
        - `locale` string: The locale of the email which will be used to invite the contact, in BCP47 format.
        - `phone` string: The phone number for the contact.
      - `identifiers` InviteeIdentifier[]: The identifiers of the invitee.
        - `type` 'VAT' | 'SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU': Invitee identifier type.
        - `value` string: Invitee identifier value.
      - `organization` InvitationOrganization: Organization details of the invitee.
        - `name` string: Organization name.
    - `lastModifiedDateTime` string, date-time: The datetime when the invitation was last modified, in ISO-8601 format.
    - `status` 'ACCEPTED' | 'DECLINED' | 'IN_PROGRESS' | 'CANCELLED' | 'EXPIRED': The current status of the invitation.

## Other responses

- `400`: Bad request. Malformed or an invalid request

---

[API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)