projects

Create a project

post/projects

Request body

namestring required

The name of the project

id_organizationstring

The organization ID

id_userstring required

The user ID

Example request

{
  "name": "Project Name",
  "id_organization": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "id_user": "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
}

Response

id_projectstring required

Unique identifier for the project

namestring required

Name of the project

sync_modestring required

Synchronization mode of the project

pull_frequencynumber required

Frequency of pulling data in seconds

redirect_urlstring required

Redirect URL for the project

id_userstring required

User ID associated with the project

id_connector_setstring required

Connector set ID associated with the project

Example response

{
  "id_project": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Project",
  "sync_mode": "automatic",
  "pull_frequency": 3600,
  "redirect_url": "https://example.com/redirect",
  "id_user": "123e4567-e89b-12d3-a456-426614174001",
  "id_connector_set": "123e4567-e89b-12d3-a456-426614174002"
}

Changes

Changed in 5 of the 18 revisions of this API.45

    • the response property pull_frequency became required for the status 201

      response-property-became-required

    • the response property redirect_url became required for the status 201

      response-property-became-required

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property pull_frequency became optional for the status 201

      response-property-became-optional

    • the response property redirect_url became optional for the status 201

      response-property-became-optional

    • the response property pull_frequency became required for the status 201

      response-property-became-required

    • the response property redirect_url became required for the status 201

      response-property-became-required

    • the response property pull_frequency became optional for the status 201

      response-property-became-optional

    • the response property redirect_url became optional for the status 201

      response-property-became-optional

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added