Skip to main content
GET
/
invitation
/
company
/
{company_id}
List Invitations by Company
curl --request GET \
  --url https://external.nectarclimate.com/v2.1/invitation/company/{company_id} \
  --header 'X-API-KEY: <api-key>'

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
company_id
string<uuid>
required

ID of the company.

Query Parameters

​
invitationType
enum<string>

Filter by invitation type.

Available options:
CREATE_CONNECTION,
EDIT_CONNECTION
​
limit
integer

Items per page (default 25, max 100).

​
page
integer

Page number (default 1).

​
status
enum<string>

Filter by invitation status.

Available options:
ACTIVE,
EXPIRED,
FULFILLED,
REVOKED

Response

200

Paginated invitation list.