Get Invitations

GET

/public/v3/invitations

Parameters

none

Query parameters

none

Request body parameters

none

Response body parameters

ParameterData typeRequired?Description
dataInvitationyesArray of Invitations

Invitation

ParameterData typeRequired?Description
idstringyesInvitation ID
customer_typestringyesAllowed:(Individual, Business)
last_namestringnoLast name
first_namestringnoFirst name
company_namestringnoCompany name
emailstringyesemail
phonestringnophone
referencestringyesInvitation reference
send_emailbooleanyesDetermines if the invitation e-mail was sent
created_atintegeryesTimestamp
revoked_atintegeryesTimestamp
used_atintegeryesTimestamp
expires_inintegeryesTimestamp
urlstringyesInvitation URL

Request example

1 curl --location --request GET 'https://api.friendlyscore.com/public/v3/invitations'

Response example:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 { "page": 0, "pages": 0, "max_per_page": 0, "data": [ { "id": "12345", "customer_type": "Individual", "last_name": "Doe", "first_name": "John", "company_name": "Example INC.", "email": "example@example.com", "phone": "+44123456789", "reference": "some-reference-id", "send_email": false, "created_at": "1553077496", "revoked_at": "1553077496", "used_at": "1553077496", "expires_in": "3600", "url": "https://friendlyscore.com/invitation/123456789abcdef" } ], "_links": { "self": { "href": "string" }, "next": { "href": "string" }, "previous": { "href": "string" }, "last": { "href": "string" } } }

Was this article helpful?

Friendly Score UK Ltd.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 781963)