Rate this page
- ★★
- ★★
- ★★
- ★★
- ★★
Can we improve this page? Send us feedbackRate this page
- ★★
- ★★
- ★★
- ★★
- ★★
The Notehub project API provides RESTful methods that can be used to GET and
POST project data.
Get information about a Notehub project by ProjectUID.
Minimum Notehub project-level role required:
curl -X GET -L 'https://api.notefile.net/v1/projects/<projectUID>' -H 'Authorization: Bearer <access_token>'
uidstring
The globally-unique identifier of the project.
labelstring
The user-assigned label for the project.
createdstring
The date and time the project was created in Notehub.
administrative_contactobject
Contact information for the administrative contact assigned in Notehub.
technical_contactobject
Contact information for the technical contact assigned in Notehub.
rolestring
The role of the project member creating the API request.
{ "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" }, "role": "owner" }
Get all Notehub projects accessible by provided authentication token.
Minimum Notehub project-level role required:
curl -X GET -L 'https://api.notefile.net/v1/projects' -H 'Authorization: Bearer <access_token>'
uidstring
The globally-unique identifier of the project.
labelstring
The user-assigned label for the project.
createdstring
The date and time the project was created in Notehub.
administrative_contactobject
Contact information for the administrative contact assigned in Notehub.
technical_contactobject
Contact information for the technical contact assigned in Notehub.
rolestring
The role of the project member creating the API request.
{ "projects":[ { "uid": "app:00000000-0000-0000-0000-000000000000", "label": "First 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" }, "role":"owner" }, { "uid": "app:00000000-0000-0000-0000-000000000000", "label": "Second Notehub Project", "created": "2022-07-26T19:11:05Z", "administrative_contact": { "name": "Jane Doe", "email": "someone@example.com", "role": "Admin", "organization": "Blues Wireless" }, "technical_contact": { "name": "John Doe", "email": "someone@example.com", "role": "Tech", "organization": "Blues Wireless" }, "role":"owner" } ] }
Get information about a Notehub project by ProductUID.
Minimum Notehub project-level role required:
curl -X GET -L 'https://api.notefile.net/v1/products/<productUID>/project' -H 'Authorization: Bearer <access_token>'
uidstring
The globally-unique identifier of the project.
labelstring
The user-assigned label for the project.
createdstring
The date and time the project was created in Notehub.
administrative_contactobject
Contact information for the administrative contact assigned in Notehub.
technical_contactobject
Contact information for the technical contact assigned in Notehub.
rolestring
The role of the project member creating the API request.
{ "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" }, "role": "owner" }
Get all members from a Notehub project.
Minimum Notehub project-level role required:
curl -X GET -L 'https://api.notefile.net/v1/projects/<projectUID>/members' -H 'Authorization: Bearer <access_token>'
namestring
The name of the project member.
emailstring
The email address of the project member (only provided if the auth token provider is an owner of the project).
rolestring
The role of the project member (e.g. viewer, developer, or owner).
{ "members":[ { "name": "Jane Doe", "email": "someone@blues.com", "role": "owner" }, { "name": "John Doe", "email": "someone@blues.com", "role": "developer" } ] }
Create a new Notehub project.
Minimum Notehub project-level role required:
access_tokenstring
A Notehub API bearer token.
labelstring
The label of the Notehub project.
billing_account_uidstring
The globally-unique identifier of the billing account. The caller of the API must be able to create projects within the specified billing account, otherwise an error will be returned. This identifier is available with a call to Get Billing Accounts.
curl -X POST -L 'https://api.notefile.net/v1/projects' -H 'Authorization: Bearer <access_token>' -d '{"label":"<label>"}'
uidstring
The globally-unique identifier of the project.
labelstring
The user-assigned label for the project.
createdstring
The date and time the project was created in Notehub.
administrative_contactobject
Contact information for the administrative contact assigned in Notehub. Will be
null on newly-created projects.
technical_contactobject
Contact information for the technical contact assigned in Notehub. Will be
null on newly-created projects.
rolestring
The role of the project member creating the API request.
{ "uid": "app:00000000-0000-0000-0000-000000000000", "label": "My Notehub Project", "created": "2021-04-26T19:11:05Z", "administrative_contact": null, "technical_contact": null, "role": "owner" }