List invitations

Lists invitations with pagination and expiry details.

GET https://app.upfour.io/v1/invites

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs member.read.

Query

limitqueryOptional query parameter. cursorqueryOptional query parameter. client_idqueryOptional query parameter. all_clientsqueryOptional query parameter. qqueryOptional query parameter. sortqueryOptional query parameter.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope member.read stable returns 200

Parameters

Field	Type	Description
`limit` optional	integer 1–250default `50`	query parameter
`cursor` optional	string	query parameter
`client_id` optional	uuid	query parameter
`all_clients` optional	boolean	query parameter
`q` optional	string	query parameter
`sort` optional	string	query parameter

Returns

A successful request returns 200 with application/json.

Response fields 2 top-level fields

Field Type Description

data Invite[] · nullable

Each item · 16 fields

Field	Type	Description
`created_at`	string (date-time)
`email`	string
`expired`	boolean	Always false in these answers; compare expires_at with the current time.
`expires_at`	string (date-time)
`id`	uuid
`invited_by`	uuid
`organization_id`	uuid
`role`	string one of`owneradminmemberviewereditor`	The company role; for a client portal invite (client_id set) the client member role viewer, editor or admin.
`accepted_at`	string (date-time)
`client_id`	uuid	Set for a client portal invite, whose person only sees that client.
`client_name`	string
`inviter_email`	string
`language`	string one of`ende`
`org_name`	string
`team_id`	uuid
`team_name`	string

pagination Pagination

Pagination · 5 fields

Field	Type	Description
`cursor`	string · nullable
`has_more`	boolean
`limit`	integer 1–250
`next_cursor`	string · nullable
`prev_cursor`	string · nullable

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
400	`bad_request`	The request is malformed or fails validation.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/invites", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $ch = curl_init("https://app.upfour.io/v1/invites"); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": [ { "created_at": "2026-10-27T09:00:00Z", "email": "dan@example.com", "expired": false, "expires_at": "2026-11-03T09:00:00Z", "id": "00000000-0000-4000-8000-000000000001", "invited_by": "00000000-0000-4000-8000-000000000002", "inviter_email": "anna@example.com", "language": "en", "org_name": "Acme GmbH", "organization_id": "00000000-0000-4000-8000-000000000003", "role": "member" } ], "pagination": { "cursor": null, "has_more": false, "limit": 50, "next_cursor": null, "prev_cursor": null } }