cURL
curl --request GET \ --url https://api-sandbox.argyle.com/v2/invites \ --header 'Authorization: Basic <encoded-value>'
{ "next": "https://api-sandbox.argyle.com/v2/invites?cursor=ZXhhbXBsZV9jdXJzb3I", "previous": null, "results": [ { "id": "0424137bc-edc5-35de-c1b5-1c3cddb4b227", "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69", "user_token": null, "email": "[email protected]", "phone_number": "212-555-5555", "full_name": "Sarah Longfield", "first_name": "Sarah", "last_name": "Longfield", "revoked_at": null, "status": "completed", "group_id": "d8a07e5b-13a3-11ef-af7e-c7eb00762562", "url": "https://console.argyle.com/add-work-accounts/0424137bc-edc5-35de-c1b5-1c3cddb4b227", "created_at": "2023-03-09T23:57:05.756Z", "updated_at": "2023-03-09T23:57:05.756Z", "invited_at": "2023-03-09T23:57:05.756Z", "flow_id": "8DRRA4XC", "flow_items": [ "item_000000001", "item_000000002" ], "reply_to": [ "[email protected]", "[email protected]" ], "deliveries": [ { "id": "d7c85e44-9729-11f0-b297-f3718e19503e", "method": "email", "status": "opened", "sent_at": "2023-03-09T23:57:24.000Z", "updated_at": "2023-03-09T23:57:24.000Z" } ], "invite_template_id": null }, { "id": "0186c5b8-8fa1-67b3-39af-14b3e18da8a7", "user": "f3041cb5-bf31-21cb-aa05-df294c161fd9", "user_token": null, "email": "[email protected]", "phone_number": "212-867-5309", "full_name": "Bob Jones", "first_name": "Bob", "last_name": "Jones", "revoked_at": null, "status": "initiated", "group_id": null, "url": "https://console.argyle.com/add-work-accounts/f3041cb5-bf31-21cb-aa05-df294c161fd9", "created_at": "2023-03-10T01:22:36.432Z", "updated_at": "2023-03-10T01:22:36.432Z", "invited_at": "2023-03-10T01:22:36.432Z", "flow_id": "R23CELUZ", "flow_items": [], "reply_to": [], "deliveries": [ { "id": "d7c85e44-9729-11f0-b297-f3718e19503e", "method": "email", "status": "opened", "sent_at": "2023-03-10T01:22:37.432Z", "updated_at": "2023-03-12T01:22:37.432Z" } ], "invite_template_id": null } ] }
Returns an object containing all invite objects.
Username = api_key_id, Password = api_key_secret
Filter invites by status.
Multiple status values can be searched at once using either method:
/v2/invites?status=sent,initiated
/v2/invites?status=sent&status=initiated
Filter invites for a specific reply_to email.
reply_to
Number of invite objects returned per page. Default: 10. Maximum: 200.
The URL returned in next or previous used to retrieve another page of results.
next
previous
Show child attributes
URL for the next page of results, if available.
URL for the previous page of results, if available.