invitation

Retrieve invitations sent by admin

get/api/v1/organisations/invitations

Request

Base URL
https://staging.api-golang.boilerplate.hng.tech/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/hngprojects/apis/kimiko-golang-swagger/docs/api/v1/organisations/invitations/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

Request successful

status_codeinteger

messagestring

Example response

{
  "status_code": 200,
  "message": "Request successful",
  "data": [
    {
      "email": "user@example.com",
      "org_id": "aoalj-alhljkdshj345klhsd",
      "status": "pending/approved/rejected",
      "sent_at": "2023-06-23T00:00:00Z",
      "expires_at": "2023-07-23T00:00:00Z",
      "invitation_token": "invitation-token"
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.