Get project by ID

Get the project and its sandboxes.

get

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

project_idinteger · int64 · min: 1Required

Unique project ID

Example: 4032

Responses

200

Returns project details

application/json

idintegerOptional

namestringOptional

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

get/api/projects/{project_id}

curl -X GET https://mailtrap.io/api/projects/{project_id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "id": 2388,
  "name": "My New Project",
  "share_links": {
    "admin": "https://localhost/projects/2388/share/QEVuQwEAS-hQfYV1hqw15p7p9VcsuCrASDQUkcuV_N5G-zdVBPrd58V8Ce09AUl-JGFEJsQbt-K6IzRIMhjpU7zxAnIo9QpB8mJwuOqBiottfwdDhgKO-ab7t7WDCyyoGeG5dLK_",
    "viewer": "https://localhost/projects/2388/share/QEVuQwEAS-hQfYV1hqw15p7p9VcsuCrASDQUkcuV_N5G-zdVBPrd58V8Ce09AUl-JGFEJsQbHDFqI6Mk2wRVlVSxLNMgI-3LnWpSSSyCSbjqkQRAMPVoTPYF7WcXfw4H_CwkAc4e"
  },
  "sandboxes": [],
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": false
  }
}