ProdCamp Help
Go to ProdCampSign InLeave Feedback
  • What is ProdCamp?
  • How it works
  • Getting Started
    • Getting Started with ProdCamp
    • Invite Your Team
    • Custom Domain
  • Customer feedback
    • Attaching Feedback to a Feature
    • Processing Feedback
  • Feedback Channels
    • Customer Feedback Channels
    • ProdCamp App
    • Public Roadmap
    • Feature Voting Portal
    • Email Forwarding
    • Google Chrome Extension
    • Intercom Messanger
    • Embeddable Feedback Widget
    • NPS
    • Any App (via Zapier)
  • Installing widgets
    • Installing widgets
    • Widgets SSO
    • Changelog widget
    • Feedback Widget
    • NPS widget
  • Features
    • Creating a Feature
    • Sharing Features on Public Roadmap
    • Push Feature to Jira
    • Feature Releases
    • Features and Sprints relation
  • Feedback Loop
    • Closing Feedback Loop
    • Changelog
  • Roadmaps
    • Public Roadmap
    • Single Sign-On (SSO)
    • Feature Placement on the Public Roadmap
    • Internal Roadmap
    • Protected Roadmap (beta)
  • ❌Sprints (DEPRECATED)
    • Sprints Mode
    • Create Sprint
    • Adding Features to a Sprint
    • Sprint Releases
  • Products
    • Create and Manage Products
  • Prioritization
    • Prioritization Matrix
    • RICE Prioritization
  • Customers
    • Manage Accounts and Contacts
    • Sync Accounts with SalesForce
  • Integrations
    • Slack
    • Jira
    • GitLab
    • SalesForce
    • Intercom
    • Zapier
  • Operations
    • Import Features
    • Import Customers
  • Settings
    • Profile
  • Getting Help
    • Contact Us
  • API
    • Authentication
    • Feedback API
      • Feedback Types
      • Feedback States
    • Features API
    • Customers API
Powered by GitBook
On this page

Was this helpful?

  1. API

Customers API

PreviousFeatures API

Last updated 1 year ago

Was this helpful?

Using the Customers API

API Description can be found in our Swagger docs here:

https://app.swaggerhub.com/apis/ProdCamp/prodcamp_app/v1.0#/Customers/post_api_v1_Customers_accounts
get
Query parameters
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
200
Success
application/json
get
GET /api/v1/Customers/accounts HTTP/1.1
Host: app.prodcamp.com
Accept: */*
200

Success

{
  "items": [
    {
      "id": 1,
      "accountName": "text",
      "companyName": "text",
      "status": {
        "id": 1,
        "caption": "text"
      },
      "domains": [
        "text"
      ],
      "data": {
        "id": 1,
        "website": "text",
        "phone": "text",
        "annualRevenue": 1,
        "lifetimeValue": 1,
        "employeesCount": 1,
        "description": "text",
        "industry": "text",
        "type": "text",
        "subscription": "text",
        "accountLevel": "text",
        "signupDate": "2025-05-12T14:15:09.513Z",
        "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
        "timezone": "text"
      },
      "lastEditDate": "2025-05-12T14:15:09.513Z",
      "createdDate": "2025-05-12T14:15:09.513Z"
    }
  ],
  "pagesCount": 1,
  "pageSize": 1,
  "currentPage": 1,
  "totalItemsCount": 1
}
get
Path parameters
idinteger · int32Required
Responses
200
Success
application/json
get
GET /api/v1/Customers/accounts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*
200

Success

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-05-12T14:15:09.513Z",
          "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-05-12T14:15:09.513Z",
        "createdDate": "2025-05-12T14:15:09.513Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-05-12T14:15:09.513Z",
    "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-05-12T14:15:09.513Z",
  "createdDate": "2025-05-12T14:15:09.513Z"
}
delete
Path parameters
idinteger · int32Required
Responses
200
Success
400
Bad Request
application/json
404
Not Found
application/json
default
Error
application/json
delete
DELETE /api/v1/Customers/accounts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*

No content

get
Query parameters
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
200
Success
application/json
get
GET /api/v1/Customers/contacts HTTP/1.1
Host: app.prodcamp.com
Accept: */*
200

Success

{
  "items": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-05-12T14:15:09.513Z",
          "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-05-12T14:15:09.513Z",
        "createdDate": "2025-05-12T14:15:09.513Z"
      },
      "accountId": 1
    }
  ],
  "pagesCount": 1,
  "pageSize": 1,
  "currentPage": 1,
  "totalItemsCount": 1
}
get
Path parameters
idinteger · int32Required
Responses
200
Success
application/json
get
GET /api/v1/Customers/contacts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*
200

Success

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-05-12T14:15:09.513Z",
      "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-05-12T14:15:09.513Z",
    "createdDate": "2025-05-12T14:15:09.513Z"
  },
  "accountId": 1
}
delete
Path parameters
idinteger · int32Required
Responses
200
Success
400
Bad Request
application/json
404
Not Found
application/json
default
Error
application/json
delete
DELETE /api/v1/Customers/contacts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*

No content

  • Using the Customers API
  • GET/api/v1/Customers/accounts
  • POST/api/v1/Customers/accounts
  • GET/api/v1/Customers/accounts/{id}
  • PUT/api/v1/Customers/accounts/{id}
  • DELETE/api/v1/Customers/accounts/{id}
  • GET/api/v1/Customers/contacts
  • POST/api/v1/Customers/contacts
  • GET/api/v1/Customers/contacts/{id}
  • PUT/api/v1/Customers/contacts/{id}
  • DELETE/api/v1/Customers/contacts/{id}
post
Body
accountNamestring | nullableOptional
domainsstring[] | nullableOptional
Responses
200
Success
application/json
400
Bad Request
application/json
post
POST /api/v1/Customers/accounts HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 346

{
  "accountName": "text",
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-05-12T14:15:09.513Z",
    "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
    "timezone": "text"
  }
}
{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-05-12T14:15:09.513Z",
          "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-05-12T14:15:09.513Z",
        "createdDate": "2025-05-12T14:15:09.513Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-05-12T14:15:09.513Z",
    "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-05-12T14:15:09.513Z",
  "createdDate": "2025-05-12T14:15:09.513Z"
}
put
Path parameters
idinteger · int32Required
Body
idinteger · int32Optional
accountNamestringRequired
companyNamestring | nullableOptional
domainsstring[] | nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
Responses
200
Success
application/json
put
PUT /api/v1/Customers/accounts/{id} HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 1257

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-05-12T14:15:09.513Z",
          "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-05-12T14:15:09.513Z",
        "createdDate": "2025-05-12T14:15:09.513Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-05-12T14:15:09.513Z",
    "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-05-12T14:15:09.513Z",
  "createdDate": "2025-05-12T14:15:09.513Z"
}
200

Success

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-05-12T14:15:09.513Z",
          "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-05-12T14:15:09.513Z",
        "createdDate": "2025-05-12T14:15:09.513Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-05-12T14:15:09.513Z",
    "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-05-12T14:15:09.513Z",
  "createdDate": "2025-05-12T14:15:09.513Z"
}
post
Body
idinteger · int32Optional
firstNamestring | nullableOptional
lastNamestring | nullableOptional
fullNamestring | nullableOptional
avatarUrlstring | nullableOptional
emailstring | nullableOptional
additionalEmailsstring[] | nullableOptional
phonestring | nullableOptional
mobilestring | nullableOptional
anotherPhonestring | nullableOptional
titlestring | nullableOptional
departmentstring | nullableOptional
companyNamestring | nullableOptional
accountIdinteger · int32 | nullableOptional
Responses
200
Success
application/json
post
POST /api/v1/Customers/contacts HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 751

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-05-12T14:15:09.513Z",
      "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-05-12T14:15:09.513Z",
    "createdDate": "2025-05-12T14:15:09.513Z"
  },
  "accountId": 1
}
200

Success

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-05-12T14:15:09.513Z",
      "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-05-12T14:15:09.513Z",
    "createdDate": "2025-05-12T14:15:09.513Z"
  },
  "accountId": 1
}
put
Path parameters
idinteger · int32Required
Body
idinteger · int32Optional
firstNamestring | nullableOptional
lastNamestring | nullableOptional
fullNamestring | nullableOptional
avatarUrlstring | nullableOptional
emailstring | nullableOptional
additionalEmailsstring[] | nullableOptional
phonestring | nullableOptional
mobilestring | nullableOptional
anotherPhonestring | nullableOptional
titlestring | nullableOptional
departmentstring | nullableOptional
companyNamestring | nullableOptional
accountIdinteger · int32 | nullableOptional
Responses
200
Success
application/json
put
PUT /api/v1/Customers/contacts/{id} HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 751

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-05-12T14:15:09.513Z",
      "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-05-12T14:15:09.513Z",
    "createdDate": "2025-05-12T14:15:09.513Z"
  },
  "accountId": 1
}
200

Success

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-05-12T14:15:09.513Z",
      "firstPurchaseDate": "2025-05-12T14:15:09.513Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-05-12T14:15:09.513Z",
    "createdDate": "2025-05-12T14:15:09.513Z"
  },
  "accountId": 1
}