Skip to content
Pando

Add a person to the organization by email (owners)

As a monorepo's invite: someone who has already signed in with that email is added now (200, status: added); otherwise the invite waits (201, status: invited) and becomes a membership at that email's first sign-in (a verified email only).

POST
https://app.gitpando.com/v1/orgs/{org}/invites
View as Markdown

Authorisation

  • credentialoptionalHTTP
  • sessionoptionalAPI key in cookie

Path parameters

  • orgstringrequired

    An organization's login. Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$

Request bodyJSONrequired

  • emailstringrequired
  • roleoptionalownerormember

Returns

200

Added now

JSON
  • statusoptionaladded
  • memberoptionalobject
    7 properties
    • loginstringrequired

      A user's login, which is their namespace, or an organization's (one space for both): 1 to 39 lower-case letters, digits and single hyphens, no hyphen at either end (input in any case is lowered). Reserved, because a namespace is the first URL segment: v1, healthz, login, logout, settings, assets, fonts, new, api, app, static, orgs, users, docs, install. A login made at sign-in comes from the email's local part, skipping reserved and taken names (base, base-2, ... base-999, then a random tail).

      pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$
    • namestring | nullrequired
    • picture_urlstring | nullrequired
    • roleownerormemberrequired
    • added_atstringrequired
      format: date-time
    • added_bystring | nullrequired

      Null for the org's creator.

    • last_active_atstring | nullrequired
      format: date-time

201

Invited; waiting for that email to sign in

JSON
  • statusoptionalinvited
  • inviteoptionalobject
    4 properties
    • emailstringrequired
    • roleownerormemberrequired
    • invited_bystringrequired
    • created_atstringrequired
      format: date-time

403

An error

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
    • messagestringrequired
    • pathsoptionalarray ofstring
    • checksoptionalobject

      GitHub's combined status, plus the required contexts and which are missing.

      6 properties
      • shastring | nullrequired
      • statesuccessorpendingorfailureorerrorormissingorunknownrequired

        success when the merge gate passes; missing when a required context has not reported; unknown while the required checks are (an unforced merge is refused).

      • requiredarray | nullrequired

        Null while unknown.

      • checks_unknownstring | nullrequired

        Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise.

      • statusesarray ofobjectrequired

        The latest status per context.

        8 properties
        • shastringrequired
        • contextstringrequired
        • statependingorsuccessorfailureorerrorrequired
        • created_atstringrequired
          format: date-time
        • target_urloptionalstring | null
        • descriptionoptionalstring | null
        • creatoroptionalstring

          The member who posted it (a login); app:<slug> for a status posted with a status token or by a CI integration; hook:<hook id> for a status token from a web hook with no app.

        • appoptionalstring | null

          The CI service that reported it (buildkite, github-actions, ...), stamped by Pando from a status token or a CI integration, never from the body or target_url. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows.

      • missingoptionalarray ofstring
Navigation

Type to search…

↑↓ navigate↵ selectEsc close