Skip to content
Picogrid Legion

Create organization invitation

Create organization invitation

Open in ChatGPT ↗Open in Claude ↗
POST
/v3/organizations/invites
curl --request POST \
  --url https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/organizations/invites \
  --header 'Content-Type: application/json' \
  --data '{ "email": "new.member@example.com", "organization_role": "FULL_ACCESS", "permissions": [ {}, {} ] }'

Send an invitation to a user to join the current organization. Requires organization ID in context and org:admin permission.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string format: email
organization_role
required
string
Allowed values: ADMIN FULL_ACCESS LIMITED
permissions
Array<object>
object
relation
required
string
resource_id
required
string
/^(\*|[a-f0-9-]{36})$/
resource_type
required
string
Example
{
  "email": "new.member@example.com",
  "organization_role": "FULL_ACCESS",
  "permissions": [
    {},
    {}
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

Resource created successfully

Media typeapplication/json
object
accepted_at
string
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$/
created_at
required
string
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$/
email
required
string format: email
expires_at
required
string
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$/
id
required
string format: uuid
organization_id
required
string format: uuid
organization_name
required
string
organization_role
required
string
Allowed values: ADMIN FULL_ACCESS LIMITED
token
string
updated_at
required
string
/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$/
Example
{
  "accepted_at": "2024-03-12T09:05:00Z",
  "created_at": "2024-03-10T10:05:00Z",
  "email": "new.member@example.com",
  "expires_at": "2024-03-17T10:00:00Z",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_name": "Example Innovations Inc.",
  "organization_role": "ADMIN",
  "token": "eyJhbGciOiJIUzI1NiIsI[...]unique_token_part[...]",
  "updated_at": "2024-03-10T10:05:00Z"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 400,
  "details": [
    {
      "Field": "organization_id",
      "Issue": "must be a valid UUID format"
    }
  ],
  "message": "Request cannot be processed due to invalid input",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 401,
  "details": [
    {
      "Field": "authorization_header",
      "Issue": "Bearer token is expired or malformed"
    }
  ],
  "message": "Authentication credentials are missing or invalid",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 403,
  "details": [
    {
      "Field": "required_scope",
      "Issue": "requires 'orion:settings:write' scope, but token only has 'orion:settings:read'"
    }
  ],
  "message": "Access denied: insufficient permissions for this resource",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{
  "code": 404,
  "details": [
    {
      "Field": "organization_id",
      "Issue": "organization with ID 'a1b2c3d4-e5f6-7890-abcd-ef1234567890' not found"
    }
  ],
  "message": "The requested resource could not be found",
  "status": "error",
  "timestamp": "2026-01-15T14:32:45Z",
  "trace_id": "req_2J9K8L7M6N5P4Q3R"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
category
required

The category of the error

string
code
required

The HTTP status code

number
details

Additional details about the error

Array<object>
object
field

The field that caused the error

string
issue

The specific issue with the field

string
message
required

A human-readable error message

string
status
required

The status of the response, always ‘error’ for error responses

string
timestamp
required

The timestamp when the error occurred

string format: date-time
trace_id
required

A unique identifier for tracing the error

string format: uuid
Example
{
  "category": "server_error",
  "code": 500,
  "details": [
    {
      "field": "field_name",
      "issue": "Field validation issue"
    }
  ],
  "message": "Internal Server Error",
  "status": "error",
  "timestamp": "2024-03-15T10:30:00Z",
  "trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"
}

Version 3.14.0 · commit 0771262