XP-Dev.com Documentation

Old Forums API

This user guide only applies if your account and project is on our old platform, i.e. if your project's URL begins with https://xp-dev.com rather than https://<your-account>.xp-dev.com. If your account is on our new platform, you should be using this user guide instead.

Each Forum Object has the following attributes:

Attribute Description
id Unique Forum ID
name Forum name
project Project ID that the Forum belongs to
publicForum Whether this is a public forum or not

Note: public forums allow any authenticated XP-Dev.com user to create topics and comment.

List All Forums

GET request to https://xp-dev.com/api/v1/forums/project/<project-id>:

curl https://xp-dev.com/api/v1/forums/project/3

Responses will be a list of Forum Objects:

{"response":[
    {
        "name":"Support",
        "id":2,
        "project":3,
        "publicForum":false
    },
    ...
]}

Create a New Forum

POST request to https://xp-dev.com/api/v1/forums/ with the following attributes:

Mandatory:

  • project
  • name
  • publicForum

Example request:

curl -X POST -H 'Content-Type: application/json' -d '{"name":"Support","project":3,"publicForum":false}' https://xp-dev.com/api/v1/forums/

Responses will be in the form of a single Forum Object

Get a Single Forum

GET request to https://xp-dev.com/api/v1/forums/<forum-id>. For example:

curl https://xp-dev.com/api/v1/forums/6

Responses will be in the form of a single Forum Object

Update a Single Forum

PUT request to https://xp-dev.com/api/v1/forums/<forum-id> with the following attributes:

Mandatory:

  • name
  • publicForum

Example request:

curl -X PUT -H 'Content-Type: application/json' -d '{"name":"Support","publicForum":true}' https://xp-dev.com/api/v1/forums/6

Responses will be in the form of a single Forum Object

Delete a Single Forum

DELETE request to https://xp-dev.com/api/v1/forums/<forum-id>:

curl -X DELETE https://xp-dev.com/api/v1/forums/6

Feel free to contact us if you need any assistance.