Rate this page

★
★
★
★
★
★
★
★
★
★

Project API

The Notehub project API provides RESTful methods that can be used to GET project data.

Get Project

Get information about a Notehub project by ProjectUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`projectUID`

string

The ProjectUID of a Notehub project.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '{baseURL}/projects/{projectUID}'
     -H 'X-SESSION-TOKEN: {authToken}'

Response Members

`uid`

string

The globally-unique identifier of the project.

`label`

string

The user-assigned label for the project.

`created`

string

The date and time the project was created in Notehub.

`administrative_contact`

object

Contact information for the administrative contact assigned in Notehub.

`technical_contact`

object

Contact information for the technical contact assigned in Notehub.

Example Response


{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": {
    "name": "John Doe",
    "email": "someone@example.com",
    "role": "Admin",
    "organization": "Blues Wireless"
  },
  "technical_contact": {
    "name": "Jane Doe",
    "email": "someone@example.com",
    "role": "Tech",
    "organization": "Blues Wireless"
  }
}

Get Project by Product

Get information about a Notehub project by ProductUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID of a Notehub product.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '{baseURL}/products/{productUID}/project'
     -H 'X-SESSION-TOKEN: {authToken}'

Response Members

`uid`

string

The globally-unique identifier of the project.

`label`

string

The user-assigned label for the project.

`created`

string

The date and time the project was created in Notehub.

`administrative_contact`

object

Contact information for the administrative contact assigned in Notehub.

`technical_contact`

object

Contact information for the technical contact assigned in Notehub.

Example Response


{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": {
    "name": "John Doe",
    "email": "someone@example.com",
    "role": "Admin",
    "organization": "Blues Wireless"
  },
  "technical_contact": {
    "name": "Jane Doe",
    "email": "someone@example.com",
    "role": "Tech",
    "organization": "Blues Wireless"
  }
}

Product API