{
  "opencollection": "1.0.0",
  "info": {
    "name": "Fieldguide api companies API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "companies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List available Companies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.fieldguide.io/v1/companies",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter to show companies of a specific type"
              },
              {
                "name": "uuids",
                "value": "",
                "type": "query",
                "description": "Filter Companies by UUID. Repeat the query parameter for multiple UUIDs."
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "Sort order for paginated results. Use `desc` to reverse the default ascending order."
              }
            ]
          },
          "docs": "List available Companies"
        },
        {
          "info": {
            "name": "Create a new Company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.fieldguide.io/v1/companies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Company"
        },
        {
          "info": {
            "name": "Fetch the specified Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.fieldguide.io/v1/companies/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "The UUID of the Company to retrieve"
              }
            ]
          },
          "docs": "Fetch the specified Company"
        },
        {
          "info": {
            "name": "Update the specified Company",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.fieldguide.io/v1/companies/:uuid",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "The UUID of the Company to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the specified Company"
        },
        {
          "info": {
            "name": "Get engagements for a given company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.fieldguide.io/v1/companies/:uuid/engagements",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "The UUID of the Company to retrieve engagements from"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "Sort order for paginated results. Use `desc` to reverse the default ascending order."
              }
            ]
          },
          "docs": "Get engagements for a given company"
        },
        {
          "info": {
            "name": "List Users that belong to the specified Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.fieldguide.io/v1/companies/:uuid/users",
            "params": [
              {
                "name": "uuid",
                "value": "",
                "type": "path",
                "description": "The UUID of the Company to retrieve Users for"
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter Users by email address (case-insensitive, partial match)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "Sort order for paginated results. Use `desc` to reverse the default ascending order."
              }
            ]
          },
          "docs": "List Users that belong to the specified Company"
        }
      ]
    }
  ],
  "bundled": true
}