List user invitations

3 minute read

GET https://www.digicert.com/services/v2/user/invite

Use this endpoint to retrieve user invitations, including invitations that are awaiting or require administrator approval. Use the invitation ID from the response to approve an invitation.

Include accepted in the filters[status] value to return invitations created through DigiCert ONE Login. Without this value, the response can include the number of invitations in page.total without including the corresponding invitation information in the invites array.

Example requests and responses

curl --globoff --request GET \
  --url 'https://www.digicert.com/services/v2/user/invite?limit=25&offset=0&filters[status][0]=pending&filters[status][1]=accepted&content_type=json' \
  --header 'X-DC-DEVKEY: {{api_key}}'

200 OK

{
  "invites": [
    {
      "id": 66374958,
      "date_created": "2025-12-10T22:38:37+00:00",
      "date_accepted": "2025-12-10T22:38:37+00:00",
      "last_sent_date": "2025-12-10T22:38:37+00:00",
      "status": "accepted",
      "email": "john.doe@email.com",
      "container_id": 92231,
      "user": {
        "id": 179414,
        "first_name": "John",
        "last_name": "Doe"
      },
      "requested_user": {
        "email": "john.doe@email.com"
      }
    }
  ],
  "page": {
    "total": 1
  }
}

Filters and URL query parameters

This endpoint supports filtering by invitation status. To provide multiple status values, use a zero-based index for each value, such as filters[status][0]=pending&filters[status][1]=accepted.

Name	Req/Opt	Type	Description
filters[status][`{{index}}`]	optional	string	Filters results by invitation status. Use `pending` to retrieve pending invitations and `accepted` to retrieve invitations generated through DigiCert ONE Login. Allowed values: accepted, expired, or cancelled.
offset	optional	int	Zero-based index of the first invitation to include in the response. Example: `0`
limit	optional	int	Maximum number of invitations to include in the response. Example: `25`
content_type	optional	string	Response format. Allowed value: `json`

Request parameters

This endpoint does not accept a request body.

Response parameters

Name	Type	Description
invites	array of objects	User invitations that match the request filters. This array can be omitted when DigiCert ONE Login invitations are counted in `page.total` but `accepted` is not included in the status filter.
.. id	int	Invitation ID. Use this value as the `invitation_id` path parameter when approving the invitation.
.. date_created	string	Date and time the invitation was created. Format: UTC timezone and ISO 8601 date
.. date_accepted	string	Date and time the invitation was accepted. For an invitation that has not been accepted, this value can be `null`. Format: UTC timezone and ISO 8601 date
.. last_sent_date	string	Date and time the invitation was most recently sent. Format: UTC timezone and ISO 8601 date
.. status	string	Current invitation status. Values are `pending` and `accepted`.
.. email	string	Email address associated with the invitation.
.. container_id	int	ID of the container (division) associated with the invitation.
.. user	object	Details about the user associated with the invitation.
.. .. id	int	User ID.
.. .. first_name	string	User's first name.
.. .. last_name	string	User's last name.
.. requested_user	object	User information submitted with the invitation request.
.. .. email	string	Email address submitted for the requested user.
page	object	Details about the paginated results. For more information, see Page details object.
.. total	int	Total number of invitations that match the request filters.