SCscanopy
Invites

Get invite by ID

Changed on
get/api/v1/invites/{id}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/invites/{id}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Invite ID

Response

Invite details

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api operation id get_invite removed and replaced with get_invite_by_id

  • a6ea2ab6fbb9Revision changes
    • breaking

      removed the required property ///// from the response with the status

    • info

      added the required property ///// to the response with the status