Company Users - GetBric/API GitHub Wiki

Company Users are the users who you will grant access to Bric.

Company Users Index

• Route: /company_users
• Method: GET
• Expected Response:

{
  "company_users": [
    {
      "id": 421690987,
      "link": "https://api.getbric.com/v1/company_users/421690987",
      "user": {
        "email": "[email protected]"
      },
      "role": "owner",
      "created_at": "2015-11-19T01:26:01.000-05:00",
      "updated_at": "2015-11-19T01:26:01.000-05:00"
    },
    {
      "id": 983044855,
      "link": "https://api.getbric.com/v1/company_users/983044855",
      "user": {
        "email": "[email protected]"
      },
      "role": "test",
      "created_at": "2015-11-19T12:41:18.868-05:00",
      "updated_at": "2016-01-26T15:23:39.821-05:00"
    },
    {
      "id": 983044863,
      "link": "https://api.getbric.com/v1/company_users/983044863",
      "user": {
        "email": "[email protected]"
      },
      "role": "project_manager",
      "view_revenue": "true",
      "created_at": "2016-04-01T17:27:38.270-04:00",
      "updated_at": "2016-04-14T11:22:52.577-04:00"
    },
    {
      "id": 983044862,
      "link": "https://api.getbric.com/v1/company_users/983044862",
      "user": {
        "email": "[email protected]"
      },
      "role": "reports",
      "view_revenue": "false",
      "created_at": "2016-03-25T12:45:14.656-04:00",
      "updated_at": "2016-04-14T11:23:02.900-04:00"
    }
  ]
}

Company User Create

• Route: /company_users/
• Method: POST
• Required Fields:
  • email
  • role (Allowed parameters: Choose one of owner, admin, project_manager, reports, or employee.)
• Allowed Fields:
  • view_revenue (Allowed parameters: Choose either true or false. This should only be entered for users with a role of project_manager or reports. Owners and Admins can always view revenue. Employees never can.)
• Expected Response: If the email address isn't already in our system you will get:

{[email protected] has been invited to Bric.}

Otherwise, you will see:

{
  "company_users": {
    "id": 983044863,
    "link": "https://api.getbric.com/v1/company_users/983044863",
    "user": {
      "email": "[email protected]"
    },
    "role": "project_manager",
    "view_revenue": "true",
    "created_at": "2016-04-01T17:27:38.270-04:00",
    "updated_at": "2016-04-14T11:22:52.577-04:00"
  }
}

Company User Show

• Route: /company_users/id
• Method: GET
• Expected Response:

{
  "company_users": {
    "id": 983044863,
    "link": "https://api.getbric.com/v1/company_users/983044863",
    "user": {
      "email": "[email protected]"
    },
    "role": "project_manager",
    "view_revenue": "true",
    "created_at": "2016-04-01T17:27:38.270-04:00",
    "updated_at": "2016-04-14T11:22:52.577-04:00"
  }
}

Company User Update

• Route: /company_users/id
• Method: PATCH
• Allowed Fields:
  • role (Allowed parameters: Choose one of owner, admin, project_manager, reports, or employee.)
  • view_revenue (Allowed parameters: Choose either true or false. This should only be entered for users with a role of project_manager or reports. Owners and Admins can always view revenue. Employees never can.)
• Expected Response:

{
  "company_users": {
    "id": 983044863,
    "link": "https://api.getbric.com/v1/company_users/983044863",
    "user": {
      "email": "[email protected]"
    },
    "role": "project_manager",
    "view_revenue": "true",
    "created_at": "2016-04-01T17:27:38.270-04:00",
    "updated_at": "2016-04-14T11:22:52.577-04:00"
  }
}

Company User Destroy

• Route: /company_users/id
• Method: DELETE
• Expected Response:

{
  "company_users": {
    "id": 983044863,
    "link": "https://api.getbric.com/v1/company_users/983044863",
    "user": {
      "email": "[email protected]"
    },
    "role": "project_manager",
    "view_revenue": "true",
    "created_at": "2016-04-01T17:27:38.270-04:00",
    "updated_at": "2016-04-14T11:22:52.577-04:00"
  }
}