FRfriendlyscore
08. Invitation

Get invitations

Changed on
get/public/v3/invitations

Request

  • Base URL
    https://api.friendlyscore.com (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Query parameters

pageinteger

Page (default is 1)

max_per_pageinteger

Max results per page (deafult is 1000)

is_usedinteger

0|1

is_revokedinteger

0|1

is_expiredinteger

0|1

customer_typestring

Business|Personal

referencestring

Customer reference

Response

Returns an array of CustomerInvitation's

pageinteger
pagesinteger
max_per_pageinteger

Maximum item count per page

Example response

{
  "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",
      "created_at": "1553077496",
      "revoked_at": "1553077496",
      "used_at": "1553077496",
      "url": "https://friendlyscore.com/invitation/123456789abcdef"
    }
  ]
}

Changes