Invites
Get user's invites
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
inviteType?string
Type of invites to retrieve. Possible values:
all: Retrieve all invites.inviter: Retrieve invites sent by the user.invitee: Retrieve invites received by the user.
Default
"all"Value in
- "all"
- "inviter"
- "invitee"
status?|array<>
Array of invite statuses to filter by. If provided, each element must be one of:
activecanceledacceptedSupports duplication (e.g.,['accepted', 'active', 'accepted']).
Default
[]Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/invites"{ "inviter": [ { "id": "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "inviterId": "5bc254e2-253a-4bfc-86e9-cbe19cbf4427", "inviteeEmail": "bernice_koss@hotmail.com", "inviteeId": "6694aecb-0165-405a-8de1-2cdd9ccbaf79", "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "resourceType": "workspace", "role": "workspaceAdmin", "additionalRoles": [ "workspaceChatMember" ], "expires": "2023-12-15T12:12:34.784Z", "status": "active", "createdAt": 1704461497862, "updatedAt": 1704461497862, "resource": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "description": "string", "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85", "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0", "color": "string", "settings": {}, "roles": [ "string" ], "status": "active", "createdAt": 1678886400000, "updatedAt": 1678886400000 }, "inviter": "3e5080e8-b7a9-460f-9c66-5a47b4c17d78", "invitee": "ab92699c-315b-4010-b1d2-37c34441e8ae" } ], "invitee": [ { "id": "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "inviterId": "5bc254e2-253a-4bfc-86e9-cbe19cbf4427", "inviteeEmail": "bernice_koss@hotmail.com", "inviteeId": "6694aecb-0165-405a-8de1-2cdd9ccbaf79", "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "resourceType": "workspace", "role": "workspaceAdmin", "additionalRoles": [ "workspaceChatMember" ], "expires": "2023-12-15T12:12:34.784Z", "status": "active", "createdAt": 1704461497862, "updatedAt": 1704461497862, "resource": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "description": "string", "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85", "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0", "color": "string", "settings": {}, "roles": [ "string" ], "status": "active", "createdAt": 1678886400000, "updatedAt": 1678886400000 }, "inviter": "3e5080e8-b7a9-460f-9c66-5a47b4c17d78", "invitee": "ab92699c-315b-4010-b1d2-37c34441e8ae" } ]}