Get a project by ID | Monite Documentation

curl https://api.sandbox.monite.com/v1/projects/project_id \
     -H "x-monite-version: 2023-09-01" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>"

{
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "entity_id": "entity_id",
  "name": "Marketing",
  "code": "code",
  "color": "color",
  "created_by_entity_user_id": "created_by_entity_user_id",
  "description": "description",
  "end_date": "end_date",
  "parent_id": "parent_id",
  "partner_metadata": {
    "key": "value"
  },
  "start_date": "start_date",
  "tags": [
    {
      "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "created_at": "2022-09-07T16:35:18Z",
      "updated_at": "2022-09-07T16:35:18Z",
      "name": "Marketing",
      "category": "document_type",
      "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
      "description": "Tag for the Marketing Department"
    }
  ]
}

Get a project with the given ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequired

Response

Successful Response

idstringformat: "uuid"

A unique ID assigned to this project.

created_atdatetime

Project created at

updated_atdatetime

Last time project was updated at

entity_idstringformat: "uuid"

The ID of the entity to which the project was issued.

namestring1-255 characters

The project name.

codestringformat: "^[a-zA-Z0-9]+$"1-20 characters

Project code

colorstring<=128 characters

Project color

created_by_entity_user_idstringformat: "uuid"

Project created by entity user

descriptionstring<=1024 characters

Description of project

end_datestringformat: "date"

Project end date

parent_idstringformat: "uuid"

Parent project ID

partner_metadatamap from strings to any

Project metadata

start_datestringformat: "date"

Project start date

tagslist of objects

A list of user-defined tags (labels) assigned to this project.

Errors

400

Get Projects ID Request Bad Request Error

401

Get Projects ID Request Unauthorized Error

403

Get Projects ID Request Forbidden Error

404

Get Projects ID Request Not Found Error

422

Get Projects ID Request Unprocessable Entity Error

500

Get Projects ID Request Internal Server Error

Authentication

Path parameters

Headers

Response

Errors