Projects
Show a single company project
Shows a single contractor project by its ID.
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
- Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
- Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.
Scopes
Any one of the scopes in a token type's row is enough. all:read and all:write work too.
| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage projects (projects) | View projects (project:read) | Manage projects (project:write) |
| Company-scoped access token (assertion) | Manage projects (projects) | View projects (project:read) | Manage projects (project:write) |
| Customer API token | Manage projects (projects) | View projects (project:read) | Manage projects (project:write) |
get/v1/projects/{id}
Request
- Base URLhttps://gateway.remote.com
- URLhttps://gateway.remote.com/v1/projects/{id}
- Auth
- OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: project:read
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:write
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: project:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer
Path parameters
idstring uuid required
A unique identifier in UUID v4 format.
Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5
Project identifier
Response
Success
Example response
{
"data": {
"project": {
"budget": {
"amount": 250000,
"currency": "USD"
},
"code": "WEB-001",
"description": "Redesign the company website",
"end_date": null,
"id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
"lead_ids": [
"663e0b79-c893-45ff-a1b2-f6dcabc098b5"
],
"name": "Website redesign",
"start_date": "2026-01-01",
"status": "active",
"team_member_ids": [
"663e0b79-c893-45ff-a1b2-f6dcabc098b5"
]
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.