Get Multi-Link (By Multi-Link ID)

Request

GET

https://api.sourcecraft.tech/invite-multilinks/id:{link_id}

Path parameters

Name

Description

link_id

Type: string

Example: ``

Responses

200 OK

A successful response.

Body

application/json
{
  "id": "example",
  "org_id": "example",
  "org_slug": "example",
  "slug": "example",
  "url": "example",
  "ttl_in_days": 0,
  "expires_at": "2025-01-01T00:00:00Z",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z",
  "accepted_count": 0,
  "invitee_count": 0,
  "org_role": "viewer",
  "repo": {
    "repo_id": "example",
    "repo_slug": "example",
    "repo_role": null
  },
  "team_id": "example",
  "restricted_to_count": 0
}

Name

Description

accepted_count

Type: integer

created_at

Type: string<date-time>

Example: 2025-01-01T00:00:00Z

expires_at

Type: string<date-time>

Example: 2025-01-01T00:00:00Z

id

Type: string

Example: example

invitee_count

Type: integer

Maximum number of invitees who can accept the invitation. Unset means unlimited.

org_id

Type: string

Example: example

org_role

Type: RepoRole

Enum: viewer, contributor, developer, maintainer, admin

org_slug

Type: string

Example: example

repo

Type: RepoAssignment

RepoAssignment specifies a repository and the role granted to a multi-link invitee.

Example
{
  "repo_id": "example",
  "repo_slug": "example",
  "repo_role": "viewer"
}

restricted_to_count

Type: integer

Number of invitee restrictions configured on the multi-link. When zero, the
link is open to anyone; otherwise only the invitees listed via the invitees
sub-resource are allowed to accept it. Use ListMultiLinkInvitees to fetch
the full list.

slug

Type: string

Example: example

team_id

Type: string

IAM group ID of the team users join upon acceptance. Obtain it from
GET /orgs/{org_slug}/teams. The team belongs to this multi-link's organization.
Unset means no team assignment.

Example: example

ttl_in_days

Type: integer

Time-to-live in days. If unset, the link never expires.

updated_at

Type: string<date-time>

Example: 2025-01-01T00:00:00Z

url

Type: string

Example: example

RepoRole

Type: string

Enum: viewer, contributor, developer, maintainer, admin

RepoAssignment

RepoAssignment specifies a repository and the role granted to a multi-link invitee.

Name

Description

repo_id

Type: string

Example: example

repo_role

Type: RepoRole

Enum: viewer, contributor, developer, maintainer, admin

repo_slug

Type: string

Example: example

Example
{
  "repo_id": "example",
  "repo_slug": "example",
  "repo_role": "viewer"
}

default

Both Client Errors (4xx) and Server Errors (5xx) are serialized into this scheme

Body

application/json
{
  "error_code": "example",
  "message": "example",
  "request_id": "example",
  "details": null
}

Name

Description

details

Type: unknown

Example: null

error_code

Type: string

Example: example

message

Type: string

Example: example

request_id

Type: string

Example: example