Get invite link
/v2/invite_links/{invite_link_id}Returns the invite link with the given ID.
Only available to organization owners and managers with the invite members permission.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
invite_link_idrequired | path | integer (int32) | Invite link ID |
Responses
200An invite link
- invite_linkobjectobject
InviteLink model
- idinteger required
Invite link ID
- namestring required
Invite link name
- urlstring required
Shareable invite URL
- rolestring required
The role users joining via the link will be added as (project_user or project_viewer). Null when no role is assigned (legacy links)
- statusstring required
Invite link status (active, disabled or expired). The expiry cause is derivable from expires_on and use_cap/used_count
- enabledboolean required
Whether the link is enabled
- deletableboolean required
Whether the link can be deleted (false for the organization's default link)
- expires_onstring required
Expiration date (null means the link never expires)
- use_capinteger required
Maximum number of joins allowed (null means unlimited)
- used_countinteger required
Number of users who joined via the link
- project_idsarray required
Projects users are added to when joining via the link
array<integer>Projects users are added to when joining via the link
itemsinteger(int64) - team_idsarray required
Teams users are added to when joining via the link
array<integer>Teams users are added to when joining via the link
itemsinteger(int64) - pay_ratestring
Pay rate assigned to users joining via the link
- created_atstring required
When the record was created
- updated_atstring required
When the record was last updated
{
"invite_link": {
"id": 0,
"name": "string",
"url": "https://example.com/resource",
"role": "string",
"status": "string",
"enabled": false,
"deletable": false,
"expires_on": "2024-01-15",
"use_cap": 0,
"used_count": 0,
"project_ids": [
0
],
"team_ids": [
0
],
"pay_rate": "string",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
}400Invalid parameters
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}401Unauthorized
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}403API access is only for organizations on an active plan
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}404Could not find record
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}429Rate limit exceeded
Hubstaff_Public_V2_Entities_Error model
- codestring required
Legacy string error code for backward compatibility
- error_codeinteger
Numeric error code for i18n/programmatic handling. Ranges: 10000-10999 (Auth), 11000-11999 (Validation), 12000-12999 (Resource), 13000-13999 (Rate Limit), 14000-14999 (Time Entry/Activity), 15000-15999 (System). See GET /v2/error_codes for full reference.
- errorstring required
Human-readable error message
- detailsarray
Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
array<string>Per-attribute validation errors: [{attribute, error}]. Present on validation failures.
itemsstring
{
"code": "string",
"error_code": 0,
"error": "string",
"details": [
"string"
]
}