Create a company project

Creates a new contractor project for your company.

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:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage projects (projects)-Manage projects (project:write)
Company-scoped access token (assertion)Manage projects (projects)-Manage projects (project:write)
Customer API tokenManage projects (projects)-Manage projects (project:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Project fields to create

Fields to create a new company project.

string
required
length ≤ 20

Code/identifier of the project. Must be unique within the company.

string | null

Description of the project.

date | null

Date when the project ends.

string
required
length ≤ 255

Name of the project.

date | null

Date when the project starts.

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json