getInvite

GET /api/public/account/invite

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

code string Required

code

Responses

200 */*

OK
Hide response attributes Show response attributes object
- organization_id integer(int64)
- sender_account_name string
- sender_account_organization_name string
- target_can_view_carrier_ids array[integer(int64)]
- target_can_view_other_carriers boolean
- target_carrier_id integer(int64)
- target_email string
- target_role string
- target_yard_id integer(int64)
- target_yard_name string
401

Unauthorized
403

Forbidden
404

Not Found

GET /api/public/account/invite

curl \
 -X GET http://localhost:8080/api/public/account/invite?code=string

Response examples (200)

{
  "organization_id": 42,
  "sender_account_name": "string",
  "sender_account_organization_name": "string",
  "target_can_view_carrier_ids": [
    42
  ],
  "target_can_view_other_carriers": true,
  "target_carrier_id": 42,
  "target_email": "string",
  "target_role": "string",
  "target_yard_id": 42,
  "target_yard_name": "string"
}