Social Accounts - Get Youtube Account
Getting an Influencer's social_account
Request
curl -g "http://localhost:3000/api/v1/social_account/6f2b5f15-e654-4058-9819-d433de173a20" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/social_account/:id
GET /api/v1/social_account/6f2b5f15-e654-4058-9819-d433de173a20
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "6f2b5f15-e654-4058-9819-d433de173a20",
"type": "account_tracker",
"attributes": {
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"provider_identifier": "UcGQ00Rvc",
"provider": "youtube",
"verified": false,
"description": "",
"data_processing_completed": true,
"profile_image": "http://pbgyu.com/profile_img",
"request_currency": "USD",
"metrics": {
"reach": null,
"impressions": 2900000,
"views_count": 1765222,
"likes_count": 90847,
"quotes_count": null,
"comments_count": 11790,
"dislikes_count": 2484,
"followers_count": 9000,
"following_count": 700,
"total_posts_count": 3,
"audience_sentiment": {
"neutral": 66.66666666666666,
"positive": 33.33333333333333
},
"avg_views_per_post": 0.0,
"avg_likes_per_post": 0.0,
"avg_shares_per_post": 0.0,
"avg_engagement_rate": 7208.24,
"avg_retweets_per_post": null,
"avg_comments_per_post": 0.03,
"posts_processed_count": 3,
"retweeted_posts_count": null,
"posts_to_retweets_ratio": null,
"original_post_shares_count": 78365,
"post_timeline": "June 07, 2021"
},
"posts": [
{
"id": "GQ00Rvc",
"title": "Song by me",
"created_at": "2021-06-09T08:55:46.632+01:00",
"embed_html": "https://www.youtube.com/embed/TD8Y9Fk",
"engagement": 1093146,
"likes_count": 78322,
"views_count": 1009100,
"comments_count": 3865,
"dislikes_count": 1859
},
{
"id": "vYilNc",
"title": "Song by them",
"created_at": "2021-06-07T08:55:46.632+01:00",
"embed_html": "https://www.youtube.com/embed/vYilNc",
"engagement": 695199,
"likes_count": 10100,
"views_count": 677099,
"comments_count": 7900,
"dislikes_count": 100
},
{
"id": "vYilNc",
"title": "Song by others",
"created_at": "2021-06-08T08:55:46.632+01:00",
"embed_html": "https://www.youtube.com/embed/vYilNc",
"engagement": 81998,
"likes_count": 2425,
"views_count": 79023,
"comments_count": 25,
"dislikes_count": 525
}
],
"followers": [
],
"account_growth": {
"09/06/2021": {
"followers": 9000,
"following": 700,
"total_posts": 3
}
},
"country_interaction": {
"NG": 90
},
"gender_interaction": {
},
"professional_details": {
"professional_id": "a6de8991-460e-49a4-8b51-d4119ccd75f8",
"professional_username": "gladis-hermann-d2086a6f-dd53-4ed5-9bc0-00825ff4b696"
},
"plaqad_iq_details": null
}
}
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/social_account/u78u6" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/social_account/:id
GET /api/v1/social_account/u78u6
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Social Accounts - Get Instagram Account
With username and provider
Request
curl -g "http://localhost:3000/api/v1/social_account?username=topsine&provider=instagram" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/social_account
GET /api/v1/social_account?username=topsine&provider=instagram
Accept: application/json
Content-Type: application/json
Parameters
username: topsine
provider: instagram
| Name | Description |
|---|---|
| username required | Username of the influencer |
| provider required | Provider of the account |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "e4e4b302-3a38-4ff2-97e0-09c74c43efb8",
"type": "account_tracker",
"attributes": {
"name": "Topsine",
"username": "topsine",
"provider_identifier": "17856281869",
"provider": "instagram",
"verified": false,
"description": "Our online shop is open for all your needs",
"data_processing_completed": true,
"profile_image": "https://scontent.flos8-1.fna.fbcdn.net/v/t516-885-15/54169",
"request_currency": "USD",
"metrics": {
"reach": 6,
"impressions": 13,
"views_count": null,
"likes_count": 225,
"quotes_count": null,
"comments_count": 190,
"dislikes_count": null,
"followers_count": 1240,
"following_count": 1816,
"total_posts_count": 3,
"audience_sentiment": {
"neutral": 33.33333333333333,
"negative": 16.666666666666664,
"positive": 50.0
},
"avg_views_per_post": 0.0,
"avg_likes_per_post": 1.33,
"avg_shares_per_post": null,
"avg_engagement_rate": 11.16,
"avg_retweets_per_post": null,
"avg_comments_per_post": 1.58,
"posts_processed_count": 3,
"retweeted_posts_count": null,
"posts_to_retweets_ratio": null,
"original_post_shares_count": null,
"post_timeline": "June 16, 2050"
},
"posts": [
{
"id": "17916927248",
"reach": 1143,
"title": "From creating content that resonates to being consistent.",
"post_url": "https://www.instagram.com/p/TUBFY2N/",
"created_at": "2050-06-16T15:35:34+0000",
"engagement": 168,
"media_type": "IMAGE",
"impressions": 1220,
"likes_count": 17,
"comments_count": 10
},
{
"id": "179448347058",
"reach": 1143,
"title": "How is your SocialCred rank looking this week?",
"post_url": "https://www.instagram.com/p/PPFY2NGH/",
"created_at": "2050-06-16T15:35:34+0000",
"engagement": 168,
"media_type": "VIDEO",
"impressions": 1220,
"likes_count": 104,
"comments_count": 90
},
{
"id": "179448347058",
"reach": 1143,
"title": "Being a social media A-lister is no easy feat.",
"post_url": "https://www.instagram.com/p/CBPFY2N/",
"created_at": "2050-06-16T15:35:34+0000",
"engagement": 168,
"media_type": "CAROUSEL_ALBUM",
"impressions": 1220,
"likes_count": 104,
"comments_count": 90
}
],
"followers": [
],
"account_growth": {
"09/06/2021": {
"followers": 1240,
"following": 1816,
"total_posts": 3
}
},
"country_interaction": {
"BF": 8,
"CY": 10,
"LR": 25,
"NE": 13,
"NG": 9185,
"TZ": 123
},
"gender_interaction": {
"male": 27.13,
"female": 72.62,
"unclassified": 0.25
},
"professional_details": {
"professional_id": "53886dca-c558-44e7-adee-d5d2e13da39f",
"professional_username": "emelina-treutel-62c28fba-1ba4-4e90-b45c-6382c120de63"
},
"plaqad_iq_details": null
}
}
}
Social Accounts - Get Twitter Account
Getting an Influencer's social_account
Request
curl -g "http://localhost:3000/api/v1/social_account/90b5a7e1-77ec-42ce-90af-bb91136666d1" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/social_account/:id
GET /api/v1/social_account/90b5a7e1-77ec-42ce-90af-bb91136666d1
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "90b5a7e1-77ec-42ce-90af-bb91136666d1",
"type": "account_tracker",
"attributes": {
"name": "Omenuko Ikemba",
"username": "Omeni",
"provider_identifier": "DoctorJ",
"provider": "twitter",
"verified": false,
"description": "Planning, Executing, Delivery",
"data_processing_completed": true,
"profile_image": "http://pbg.com/profile_img",
"request_currency": "USD",
"metrics": {
"reach": null,
"impressions": 78,
"views_count": 12345,
"likes_count": 1818,
"quotes_count": 67,
"comments_count": 248,
"dislikes_count": null,
"followers_count": 9000,
"following_count": 600,
"total_posts_count": 3,
"audience_sentiment": {
"negative": 100.0
},
"avg_views_per_post": 0.02,
"avg_likes_per_post": 0.17,
"avg_shares_per_post": null,
"avg_engagement_rate": 8.07,
"avg_retweets_per_post": 0.0,
"avg_comments_per_post": 1.21,
"posts_processed_count": 3,
"retweeted_posts_count": 1,
"posts_to_retweets_ratio": "2:1",
"original_post_shares_count": 47,
"post_timeline": "June 08, 2021"
},
"posts": [
{
"id": "244111636544225280",
"title": "Happy Birthday @imdane. Watch out for those happy @rally pranksters from yankee.surf! #Run #Run4Life ",
"post_url": "http:twitter.com/ki",
"post_type": "quote",
"created_at": "2021-06-08T08:55:49.757+01:00",
"engagement": 1102,
"media_type": null,
"likes_count": 909,
"quotes_count": 67,
"retweet_count": 2,
"comments_count": 124
},
{
"id": "244111636544225280",
"title": "Happy Birthday @imdane. Watch out for those happy @rally pranksters from yankee.surf! #Run #Run4Life ",
"post_url": "http:twitter.com/ki",
"post_type": "retweet",
"created_at": "2021-06-08T08:55:49.757+01:00",
"engagement": 1078,
"media_type": "multiple",
"likes_count": 909,
"quotes_count": 0,
"retweet_count": 45,
"comments_count": 124
}
],
"followers": [
{
"bio": "Adventures in hunger and foolishness.",
"location": "San Francisco",
"username": "omeni",
"following": 88,
"follower_id": 7505382,
"profile_image": "http://a0.twimg.com/profile_images/323331048/me_normal.jpg",
"followers_count": 898
},
{
"bio": "Fighting hunger #Restore.",
"location": "Lagos, Nigeria",
"username": "keikei",
"following": 2450,
"follower_id": 20950517,
"profile_image": "http://a0.twimg.com/profile_images/20950517/me_normal.jpg",
"followers_count": 97000
},
{
"bio": "Tough adventures #hunger #Fighing.",
"location": "Portharcourt,Nigeria",
"username": "donnie",
"following": 104,
"follower_id": 43270542,
"profile_image": "http://a0.twimg.com/profile_images/43270542/me_normal.jpg",
"followers_count": 2300
}
],
"account_growth": {
"09/06/2021": {
"followers": 9000,
"following": 600,
"total_posts": 3
}
},
"country_interaction": {
},
"gender_interaction": {
},
"professional_details": {
"professional_id": "1e05495b-39e6-4a7a-9802-8c6be7e46893",
"professional_username": "compata-8a7a3955-be11-4f25-b489-ca844adf9a7a"
},
"plaqad_iq_details": null
}
}
}
Campaigns - Create New Records
Successful with valid params
Request
curl "http://localhost:3000/api/v1/businesses/b2a995b1-dd50-495d-8255-2ac4772086e9/campaigns" -d '{"campaign":{"business_id":"b2a995b1-dd50-495d-8255-2ac4772086e9","campaign_name":"Grimes, Stanton and Baumbach","description":"Libero enim tenetur. Animi aut consequuntur. Consequatur beatae sed.","professional_types":["influencer"],"live_metrics_enabled":false,"start_date":"2021-06-09","end_date":"2021-07-09","niche":["Politics"],"hide_business_name":true,"hide_jobs":true,"hide_campaign_name":true,"hide_budget":true}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: bobby.haag@nitzsche.net" \
-H "Authorization: TcNyLsLoXDrbakmZvNxi" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/campaigns
POST /api/v1/businesses/b2a995b1-dd50-495d-8255-2ac4772086e9/campaigns
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"b2a995b1-dd50-495d-8255-2ac4772086e9","campaign_name":"Grimes, Stanton and Baumbach","description":"Libero enim tenetur. Animi aut consequuntur. Consequatur beatae sed.","professional_types":["influencer"],"live_metrics_enabled":false,"start_date":"2021-06-09","end_date":"2021-07-09","niche":["Politics"],"hide_business_name":true,"hide_jobs":true,"hide_campaign_name":true,"hide_budget":true}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[source] | Identifies campaign created with professional-invite |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "a049eade-5e31-495c-8f9f-df3b9f2db9b9",
"type": "campaign",
"attributes": {
"business_id": "b2a995b1-dd50-495d-8255-2ac4772086e9",
"campaign_name": "Grimes, Stanton and Baumbach",
"professional_types": [
"influencer"
],
"description": "Libero enim tenetur. Animi aut consequuntur. Consequatur beatae sed.",
"live_metrics_enabled": false,
"goals": null,
"niche": [
"Politics"
],
"created_by": "e63ab188-e1d3-4899-a86d-cc1febcd6f77",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-09",
"currency": "USD",
"hide_business_name": true,
"hide_jobs": true,
"hide_campaign_name": true,
"hide_budget": true,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "9th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Streich LLC",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
}
Successful with valid params
Request
curl "http://localhost:3000/api/v1/businesses/73e75a26-3f53-4c05-9227-1af2be22e577/campaigns" -d '{"campaign":{"business_id":"73e75a26-3f53-4c05-9227-1af2be22e577","campaign_name":"Streich and Sons","description":"Reiciendis dolores temporibus. Repudiandae reiciendis exercitationem. Consectetur numquam occaecati.","professional_types":["influencer"],"live_metrics_enabled":false,"start_date":"2021-06-09","end_date":"2021-07-09","budget":50000,"goals":"Et commodi esse. Recusandae tempora eaque. Earum et quo.","niche":["Politics"],"source":"via_invitation","hide_business_name":true,"hide_jobs":true,"hide_campaign_name":true,"hide_budget":true}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: antoine_kuhlman@batz.com" \
-H "Authorization: b5_9MVxfUAr6napPfRxa" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/campaigns
POST /api/v1/businesses/73e75a26-3f53-4c05-9227-1af2be22e577/campaigns
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"73e75a26-3f53-4c05-9227-1af2be22e577","campaign_name":"Streich and Sons","description":"Reiciendis dolores temporibus. Repudiandae reiciendis exercitationem. Consectetur numquam occaecati.","professional_types":["influencer"],"live_metrics_enabled":false,"start_date":"2021-06-09","end_date":"2021-07-09","budget":50000,"goals":"Et commodi esse. Recusandae tempora eaque. Earum et quo.","niche":["Politics"],"source":"via_invitation","hide_business_name":true,"hide_jobs":true,"hide_campaign_name":true,"hide_budget":true}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[source] | Identifies campaign created with professional-invite |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "852ab3e0-e57b-4c9a-84c2-8bf72566e50f",
"type": "campaign",
"attributes": {
"business_id": "73e75a26-3f53-4c05-9227-1af2be22e577",
"campaign_name": "Streich and Sons",
"professional_types": [
"influencer"
],
"description": "Reiciendis dolores temporibus. Repudiandae reiciendis exercitationem. Consectetur numquam occaecati.",
"live_metrics_enabled": false,
"goals": "Et commodi esse. Recusandae tempora eaque. Earum et quo.",
"niche": [
"Politics"
],
"created_by": "c73ce864-5a77-4bcb-9fb5-6495631b45ca",
"status": "started",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-09",
"currency": "USD",
"hide_business_name": true,
"hide_jobs": true,
"hide_campaign_name": true,
"hide_budget": true,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "9th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Pagac Group",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
}
Failure when campaign_name is nil
Request
curl "http://localhost:3000/api/v1/businesses/f26887d4-8e0d-4db6-9ac1-1182c90db97d/campaigns" -d '{"campaign":{"business_id":"f26887d4-8e0d-4db6-9ac1-1182c90db97d","campaign_name":"","professional_types":["creator"],"start_date":"2021-06-09","end_date":"2021-07-09"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: blair@von.org" \
-H "Authorization: 3X-JeoLrSyXfk7BzE_Dh" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/campaigns
POST /api/v1/businesses/f26887d4-8e0d-4db6-9ac1-1182c90db97d/campaigns
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"f26887d4-8e0d-4db6-9ac1-1182c90db97d","campaign_name":"","professional_types":["creator"],"start_date":"2021-06-09","end_date":"2021-07-09"}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[source] | Identifies campaign created with professional-invite |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "campaign",
"errors": [
{
"source": {
"pointer": "/data/attributes/campaign_name"
},
"detail": "Campaign_name can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/businesses/e79b3071-1d6e-47c4-b592-a5ce5e8dec9c/campaigns" -d '{"campaign":{"business_id":"e79b3071-1d6e-47c4-b592-a5ce5e8dec9c","campaign_name":"Politics and Friends","professional_types":["creator"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/campaigns
POST /api/v1/businesses/e79b3071-1d6e-47c4-b592-a5ce5e8dec9c/campaigns
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"e79b3071-1d6e-47c4-b592-a5ce5e8dec9c","campaign_name":"Politics and Friends","professional_types":["creator"]}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[source] | Identifies campaign created with professional-invite |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Campaigns - Get All
Getting a list of campaigns
Request
curl -g "http://localhost:3000/api/v1/businesses/0f08dada-b1d0-4e79-a1db-08cd86540ce2/campaigns" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lenard.grady@dooleyquigley.biz" \
-H "Authorization: wZmhrBbqPh4B_hGyjfSs" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns
GET /api/v1/businesses/0f08dada-b1d0-4e79-a1db-08cd86540ce2/campaigns
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "360f9010-3a83-4c68-b683-3d2a31a97759",
"type": "campaign",
"attributes": {
"business_id": "0f08dada-b1d0-4e79-a1db-08cd86540ce2",
"campaign_name": "Schaefer-Bergnaum",
"professional_types": [
"creator",
"influencer"
],
"description": "Aperiam aliquam suscipit. In ducimus officia. Nobis maiores enim.",
"live_metrics_enabled": false,
"goals": "Animi et quaerat. Quia atque dolor. Aut neque nulla.",
"niche": [
"Politics"
],
"created_by": "b0dd5409-2cca-489e-a190-065f5f28755a",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Hills Inc",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
},
{
"id": "21314599-8c47-46f8-9eef-ffc03d0b4ee5",
"type": "campaign",
"attributes": {
"business_id": "0f08dada-b1d0-4e79-a1db-08cd86540ce2",
"campaign_name": "Koch and Sons",
"professional_types": [
"creator",
"influencer"
],
"description": "Beatae eos mollitia. Tenetur maiores placeat. In qui perferendis.",
"live_metrics_enabled": false,
"goals": "Quas deserunt blanditiis. Non ut quidem. Cupiditate harum ipsum.",
"niche": [
"Politics"
],
"created_by": "b0dd5409-2cca-489e-a190-065f5f28755a",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Hills Inc",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
},
{
"id": "c206ff12-85d6-43f8-bd6b-3ac6d5f6d8c0",
"type": "campaign",
"attributes": {
"business_id": "0f08dada-b1d0-4e79-a1db-08cd86540ce2",
"campaign_name": "Gleichner, Gutkowski and Olson",
"professional_types": [
"creator",
"influencer"
],
"description": "Atque sint et. Nisi eos libero. Itaque ipsam rerum.",
"live_metrics_enabled": false,
"goals": "Voluptas odio nihil. Sit ipsam facilis. Maxime repellendus tempora.",
"niche": [
"Politics"
],
"created_by": "b0dd5409-2cca-489e-a190-065f5f28755a",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Hills Inc",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
]
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/businesses/66327320-e3d5-4604-8d9a-21aaff13ce9e/campaigns" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns
GET /api/v1/businesses/66327320-e3d5-4604-8d9a-21aaff13ce9e/campaigns
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Campaigns - Get One
Getting a Business Campaign
Request
curl -g "http://localhost:3000/api/v1/businesses/aa889406-49e1-47ea-aeb5-79dad73f9a1c/campaigns/295040ac-ccbb-48e6-a169-c3d86e6bcd67" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: estefana@wiza.com" \
-H "Authorization: He1VoVRnND3GS1HUxLvZ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns/:id
GET /api/v1/businesses/aa889406-49e1-47ea-aeb5-79dad73f9a1c/campaigns/295040ac-ccbb-48e6-a169-c3d86e6bcd67
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "295040ac-ccbb-48e6-a169-c3d86e6bcd67",
"type": "campaign",
"attributes": {
"business_id": "aa889406-49e1-47ea-aeb5-79dad73f9a1c",
"campaign_name": "Bergstrom, Medhurst and Nienow",
"professional_types": [
"creator",
"influencer"
],
"description": "Ipsum unde inventore. Minus sint magni. Et dignissimos sed.",
"live_metrics_enabled": false,
"goals": "Earum rerum impedit. Asperiores cumque et. Qui dolor quae.",
"niche": [
"Politics"
],
"created_by": "27ae30f6-96ec-4f74-946b-74a0ff2fa240",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Heaney LLC",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/businesses/fbc08427-161a-4f9b-9578-ab0ab8b123b0/campaigns/eae05fe1-68ac-4d4f-b437-40de511ba063" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns/:id
GET /api/v1/businesses/fbc08427-161a-4f9b-9578-ab0ab8b123b0/campaigns/eae05fe1-68ac-4d4f-b437-40de511ba063
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/businesses/0b0b9f81-84bc-4d86-ac92-19bd9c7543d4/campaigns/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ken@veum.org" \
-H "Authorization: zjySBs3yEZk-au92tZp8" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns/:id
GET /api/v1/businesses/0b0b9f81-84bc-4d86-ac92-19bd9c7543d4/campaigns/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Campaigns - Start Campaign
Starts campaign without live metrics enabled
Request
curl "http://localhost:3000/api/v1/businesses/7dc70d07-b6cd-4bd2-b09f-7a70db7867fd/campaigns/f4389f74-11b1-4d0f-8391-7d0716f6fa02/start" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: terrell@danielkuhic.io" \
-H "Authorization: soMudaeHQbS8H9zMHn1q" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/start
PATCH /api/v1/businesses/7dc70d07-b6cd-4bd2-b09f-7a70db7867fd/campaigns/f4389f74-11b1-4d0f-8391-7d0716f6fa02/start
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "f4389f74-11b1-4d0f-8391-7d0716f6fa02",
"type": "campaign",
"attributes": {
"business_id": "7dc70d07-b6cd-4bd2-b09f-7a70db7867fd",
"campaign_name": "Howell-Kovacek",
"professional_types": [
"creator",
"influencer"
],
"description": "Consequatur at eum. Autem amet debitis. Aut porro expedita.",
"live_metrics_enabled": false,
"goals": "Qui repellat a. Et aliquam ipsam. Qui dolor delectus.",
"niche": [
"Politics"
],
"created_by": "2a6991d2-34e2-4d8a-97d4-fcd415157a77",
"status": "started",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": "June 09, 2021 07:55",
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Torphy-Windler",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
}
With live metrics enabled, starts campaign and creates campaign trackers
Request
curl "http://localhost:3000/api/v1/businesses/4cab0597-39c9-412d-9b31-932647bd0206/campaigns/97e937fb-459c-4398-bd5a-484aab747e34/start" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: hugo@schroeder.com" \
-H "Authorization: 7zjwBo_xHgPuwhfzd1mU" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/start
PATCH /api/v1/businesses/4cab0597-39c9-412d-9b31-932647bd0206/campaigns/97e937fb-459c-4398-bd5a-484aab747e34/start
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "97e937fb-459c-4398-bd5a-484aab747e34",
"type": "campaign",
"attributes": {
"business_id": "4cab0597-39c9-412d-9b31-932647bd0206",
"campaign_name": "Kuhlman, Hilpert and Oberbrunner",
"professional_types": [
"creator",
"influencer"
],
"description": "Enim maxime deleniti. Ut ut sed. Nesciunt repudiandae ad.",
"live_metrics_enabled": true,
"goals": "Debitis sit ex. Dolore aut aliquam. Et et mollitia.",
"niche": [
"Politics"
],
"created_by": "a0f1571d-7032-4215-b341-a2d5fa3d4c14",
"status": "started",
"keyword": "OhYesMember",
"hashtag": "#OhYesMember",
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": "June 09, 2021 07:55",
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": "active",
"jobs_count": 0,
"can_archive": true,
"business_name": "Medhurst-Toy",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
}
Only admin should be allowed to start campaign
Request
curl "http://localhost:3000/api/v1/businesses/962d0987-c0dc-43af-929e-aa699185af03/campaigns/8ffc207c-fc4a-4e4c-818a-537a76cc9609/start" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: donn.miller@reichel.biz" \
-H "Authorization: H3CzFWo3LFhbqtmhf957" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/start
PATCH /api/v1/businesses/962d0987-c0dc-43af-929e-aa699185af03/campaigns/8ffc207c-fc4a-4e4c-818a-537a76cc9609/start
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
403 Forbidden
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Wrong status when campaign is not draft
Request
curl "http://localhost:3000/api/v1/businesses/f828d766-42d7-4b91-abc6-b6f32cf924ac/campaigns/cc7cdef9-e7b1-42c5-bdb4-4d107fd6e228/start" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: chanel_jacobson@leuschke.io" \
-H "Authorization: xu1m25ezytYRks7c_d6d" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/start
PATCH /api/v1/businesses/f828d766-42d7-4b91-abc6-b6f32cf924ac/campaigns/cc7cdef9-e7b1-42c5-bdb4-4d107fd6e228/start
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
400 Bad Request
{
"data": {
"errors": {
"detail": "The campaign is not in the right status for this action to be performed"
}
}
}
Failure when plan limit is reached when starting campaign
Request
curl "http://localhost:3000/api/v1/businesses/3f5c3891-faab-4774-8920-c10e4f69a5c1/campaigns/4c9c958e-2b16-4019-8258-92ca8978f603/start" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: aline@mcdermottstoltenberg.info" \
-H "Authorization: -uATYVxQweLPwPG7u1Xo" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/start
PATCH /api/v1/businesses/3f5c3891-faab-4774-8920-c10e4f69a5c1/campaigns/4c9c958e-2b16-4019-8258-92ca8978f603/start
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "4c9c958e-2b16-4019-8258-92ca8978f603",
"type": "campaign",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base Oops, Plan limit reached. Kindly upgrade",
"title": "Oops, Plan limit reached. Kindly upgrade"
}
]
}
Campaigns - Update
Successful with valid params
Request
curl "http://localhost:3000/api/v1/businesses/17d7f11a-b382-4fa8-a9c2-0a70a66676e5/campaigns/274ad787-73af-463d-935f-d0753cef31ce" -d '{"campaign":{"business_id":"17d7f11a-b382-4fa8-a9c2-0a70a66676e5","description":"Tempora repellat officiis. Sed qui est. Ratione voluptatum voluptatem.","professional_types":["influencer"],"start_date":"2021-07-09","end_date":"2021-07-19","budget":60000,"goals":"Perspiciatis corporis praesentium. Sed itaque sint. Iste est corporis.","niche":["Politics"],"hide_jobs":false,"hide_campaign_name":false,"hide_budget":false}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: sunni_ankunding@fay.io" \
-H "Authorization: 26d49yoY7dz6aZS5p-9P" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:id
PATCH /api/v1/businesses/17d7f11a-b382-4fa8-a9c2-0a70a66676e5/campaigns/274ad787-73af-463d-935f-d0753cef31ce
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"17d7f11a-b382-4fa8-a9c2-0a70a66676e5","description":"Tempora repellat officiis. Sed qui est. Ratione voluptatum voluptatem.","professional_types":["influencer"],"start_date":"2021-07-09","end_date":"2021-07-19","budget":60000,"goals":"Perspiciatis corporis praesentium. Sed itaque sint. Iste est corporis.","niche":["Politics"],"hide_jobs":false,"hide_campaign_name":false,"hide_budget":false}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "274ad787-73af-463d-935f-d0753cef31ce",
"type": "campaign",
"attributes": {
"business_id": "17d7f11a-b382-4fa8-a9c2-0a70a66676e5",
"campaign_name": "Witting-Stroman",
"professional_types": [
"influencer"
],
"description": "Tempora repellat officiis. Sed qui est. Ratione voluptatum voluptatem.",
"live_metrics_enabled": false,
"goals": "Perspiciatis corporis praesentium. Sed itaque sint. Iste est corporis.",
"niche": [
"Politics"
],
"created_by": "2b842aa3-3913-4cdf-9a5b-b4deb900be60",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-07-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th July, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$60,000",
"formated_naira_value": "₦28,200,000",
"value": 60000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Bauch Group",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
}
With invalid params
Request
curl "http://localhost:3000/api/v1/businesses/a360fa09-0a49-4e6f-93e7-9eb6fdca363d/campaigns/ac533197-d41d-434c-af7c-f046ab5b7e8f" -d '{"campaign":{"business_id":"a360fa09-0a49-4e6f-93e7-9eb6fdca363d","campaign_name":""}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: stacey@kuphal.biz" \
-H "Authorization: B2sCCzfYBQdcHCoxr1Rq" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:id
PATCH /api/v1/businesses/a360fa09-0a49-4e6f-93e7-9eb6fdca363d/campaigns/ac533197-d41d-434c-af7c-f046ab5b7e8f
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"a360fa09-0a49-4e6f-93e7-9eb6fdca363d","campaign_name":""}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "ac533197-d41d-434c-af7c-f046ab5b7e8f",
"type": "campaign",
"errors": [
{
"source": {
"pointer": "/data/attributes/campaign_name"
},
"detail": "Campaign_name can't be blank",
"title": "can't be blank"
}
]
}
Campaign name cannot be changed
Request
curl "http://localhost:3000/api/v1/businesses/457446c4-ab78-46dd-8a45-ae2bd5cd9699/campaigns/da5ad9e5-4002-426b-979e-d5992b376036" -d '{"campaign":{"business_id":"457446c4-ab78-46dd-8a45-ae2bd5cd9699","campaign_name":"Eaque minima qui. Veritatis quis dolore. In dolor velit."}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: noah.trantow@reynolds.io" \
-H "Authorization: PhG4UwxdKmYc3GZgHPK7" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:id
PATCH /api/v1/businesses/457446c4-ab78-46dd-8a45-ae2bd5cd9699/campaigns/da5ad9e5-4002-426b-979e-d5992b376036
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"457446c4-ab78-46dd-8a45-ae2bd5cd9699","campaign_name":"Eaque minima qui. Veritatis quis dolore. In dolor velit."}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "da5ad9e5-4002-426b-979e-d5992b376036",
"type": "campaign",
"errors": [
{
"source": {
"pointer": "/data/attributes/name"
},
"detail": "Name Campaign name cannot be changed once published",
"title": "Campaign name cannot be changed once published"
}
]
}
Campign cannot be updated when enddate is completed
Request
curl "http://localhost:3000/api/v1/businesses/086596e9-ba6f-44c6-bba9-63f48fd02166/campaigns/300f4857-a1d0-4722-b512-71dd2196d0b3" -d '{"campaign":{"business_id":"086596e9-ba6f-44c6-bba9-63f48fd02166","end_date":"2021-06-10"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: britt@mannfeest.io" \
-H "Authorization: dozhJxZqsEhPYs5vy78G" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:id
PATCH /api/v1/businesses/086596e9-ba6f-44c6-bba9-63f48fd02166/campaigns/300f4857-a1d0-4722-b512-71dd2196d0b3
Accept: application/json
Content-Type: application/json
Parameters
{"campaign":{"business_id":"086596e9-ba6f-44c6-bba9-63f48fd02166","end_date":"2021-06-10"}}
| Name | Description |
|---|---|
| campaign[business_id] required | ID of associated business |
| campaign[campaign_name] required | Name of campaign |
| campaign[description] | Description about campaign |
| campaign[professional_types] | Professionals needed |
| campaign[live_metrics_enabled] | Enable tracking for hashtag/keywords |
| campaign[start_date] | Expected start date for campaign |
| campaign[end_date] | Expected end date for campaign |
| campaign[budget] | Planned budget |
| campaign[goals] | Goals of the campaign |
| campaign[niche] | Niche to reach |
| campaign[hashtag] | Hashtag to track |
| campaign[keyword] | Keyword to track |
| campaign[hide_business_name] | Hide business name on campaign |
| campaign[hide_jobs] | Hide jobs published under the campaign |
| campaign[hide_campaign_name] | Hide name of the campaign |
| campaign[hide_budget] | Hide budget for jobs on campaign |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "300f4857-a1d0-4722-b512-71dd2196d0b3",
"type": "campaign",
"errors": [
{
"source": {
"pointer": "/data/attributes/end_date"
},
"detail": "End_date Campaign end_date cannot be changed once ended",
"title": "Campaign end_date cannot be changed once ended"
}
]
}
Campaigns - Refresh Metrics
Refreshing Campaign Tracker Metrics
Request
curl -g "http://localhost:3000/api/v1/businesses/a02652f3-c85b-4bc5-8f37-64c8b80be04d/campaigns/5fab8807-26f1-427e-8991-e6a0871459b8/refresh_metrics" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: augustina_schmeler@faykerluke.io" \
-H "Authorization: SmE5pp2EaQD6j231vyKY" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns/:campaign_id/refresh_metrics
GET /api/v1/businesses/a02652f3-c85b-4bc5-8f37-64c8b80be04d/campaigns/5fab8807-26f1-427e-8991-e6a0871459b8/refresh_metrics
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json
200 OK
When Live metrics is not enabled
Request
curl -g "http://localhost:3000/api/v1/businesses/81403bfe-e5e5-4363-8a92-3b871418645a/campaigns/e8a5d60d-801a-44f1-8569-7ba9cd994fe7/refresh_metrics" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: nathaniel.green@kulas.info" \
-H "Authorization: s9YxN2x7zbZNzPfauN2m" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns/:campaign_id/refresh_metrics
GET /api/v1/businesses/81403bfe-e5e5-4363-8a92-3b871418645a/campaigns/e8a5d60d-801a-44f1-8569-7ba9cd994fe7/refresh_metrics
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
When campaign is not running
Request
curl -g "http://localhost:3000/api/v1/businesses/581e540b-d55a-4ecb-8bc2-43fa6452cf2b/campaigns/f3602e01-3db2-4e23-93f4-b610fb85b1d0/refresh_metrics" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: arron@ratke.io" \
-H "Authorization: 2NizpkwY-TrxnRakLmXs" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/campaigns/:campaign_id/refresh_metrics
GET /api/v1/businesses/581e540b-d55a-4ecb-8bc2-43fa6452cf2b/campaigns/f3602e01-3db2-4e23-93f4-b610fb85b1d0/refresh_metrics
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
400 Bad Request
{
"data": {
"errors": {
"detail": "Campaigns must be running before we can track the metrics"
}
}
}
Campaigns - Start Tracking
Sets trackers to active if present
Request
curl "http://localhost:3000/api/v1/businesses/d5ef3717-eea8-432b-b016-98bcc5cbdd4e/campaigns/5ddc7a7e-d9ff-4184-ab71-0bb07ef7c916/start_tracking" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: telma@spinka.name" \
-H "Authorization: jqmACDkFcYdnYaSwMgjA" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/start_tracking
PATCH /api/v1/businesses/d5ef3717-eea8-432b-b016-98bcc5cbdd4e/campaigns/5ddc7a7e-d9ff-4184-ab71-0bb07ef7c916/start_tracking
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
Returns not found when Live metrics is not enabled
Request
curl "http://localhost:3000/api/v1/businesses/dd2e27dc-430b-42d6-8676-27d6eb77e8cc/campaigns/39d66760-2d45-4fb3-932e-14a2dece4c28/start_tracking" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: chan.hayes@christiansen.name" \
-H "Authorization: ZySedJNA-67UJDCqzvxJ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/start_tracking
PATCH /api/v1/businesses/dd2e27dc-430b-42d6-8676-27d6eb77e8cc/campaigns/39d66760-2d45-4fb3-932e-14a2dece4c28/start_tracking
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Campaigns - Pausing Tracking
Pauses campaign trackers when present
Request
curl "http://localhost:3000/api/v1/businesses/02f488cc-d3dd-451c-96fb-f0fac080e61e/campaigns/ace0fb02-ef68-489f-8c4d-6c8dae4ec90d/pause_tracking" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: norbert_hills@nitzsche.name" \
-H "Authorization: 76XciuzbVKxKteEYFZRz" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/pause_tracking
PATCH /api/v1/businesses/02f488cc-d3dd-451c-96fb-f0fac080e61e/campaigns/ace0fb02-ef68-489f-8c4d-6c8dae4ec90d/pause_tracking
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
When there is no trackers, does nothing
Request
curl "http://localhost:3000/api/v1/businesses/91c1c564-99d6-44c7-bcfc-ba01c561197f/campaigns/eea7452c-baca-4f08-acc5-514920d5d79d/pause_tracking" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lakia@aufderharfeest.co" \
-H "Authorization: zsVoMDnQoKKMhVVLhUUN" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:campaign_id/pause_tracking
PATCH /api/v1/businesses/91c1c564-99d6-44c7-bcfc-ba01c561197f/campaigns/eea7452c-baca-4f08-acc5-514920d5d79d/pause_tracking
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
Campaign - Search
Search with queries returns all records
Request
curl -g "http://localhost:3000/api/v1/campaigns/search?business_id=9bdd6375-c90f-41c7-b981-ee92fa606b4e" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: zoraida.bogan@larkin.org" \
-H "Authorization: 7P51nTf5sCwhaAXGWi_t" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/search
GET /api/v1/campaigns/search?business_id=9bdd6375-c90f-41c7-b981-ee92fa606b4e
Accept: application/json
Content-Type: application/json
Parameters
business_id: 9bdd6375-c90f-41c7-b981-ee92fa606b4e
| Name | Description |
|---|---|
| business_id required | ID of associated business |
| query required | Name of campaign |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "425e6492-6935-4cf9-9ab6-100e138f2b97",
"type": "campaign",
"attributes": {
"business_id": "9bdd6375-c90f-41c7-b981-ee92fa606b4e",
"campaign_name": "Anderson-Friesen",
"professional_types": [
"creator",
"influencer"
],
"description": "Velit nam vero. Voluptatibus qui rem. Cupiditate impedit et.",
"live_metrics_enabled": false,
"goals": "Voluptas et quae. Quia commodi mollitia. Eligendi ut nesciunt.",
"niche": [
"Politics"
],
"created_by": "575f5785-07f8-4ca6-b02d-319734980868",
"status": "started",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "NGN",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": "June 07, 2021 00:00",
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$531.91",
"formated_naira_value": "₦250,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Lubowitz, Gleichner and Mitchell",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with query
Request
curl -g "http://localhost:3000/api/v1/campaigns/search?business_id=c055332d-11b5-4ed2-9de6-26a0b5039a12&query=Newspaper" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: virgie@mante.org" \
-H "Authorization: uZ7hmbRpZfFMnzW2KAFA" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/search
GET /api/v1/campaigns/search?business_id=c055332d-11b5-4ed2-9de6-26a0b5039a12&query=Newspaper
Accept: application/json
Content-Type: application/json
Parameters
business_id: c055332d-11b5-4ed2-9de6-26a0b5039a12
query: Newspaper
| Name | Description |
|---|---|
| business_id required | ID of associated business |
| query required | Name of campaign |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 0,
"total_count": 0
}
}
}
Include archive
Request
curl -g "http://localhost:3000/api/v1/campaigns/search?business_id=613ff620-1c30-43ea-9c0c-25601d3e6fc1&query=Newspaper" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: layla@dooley.org" \
-H "Authorization: C7T7y9XpGMYCUoCz1VH7" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/search
GET /api/v1/campaigns/search?business_id=613ff620-1c30-43ea-9c0c-25601d3e6fc1&query=Newspaper
Accept: application/json
Content-Type: application/json
Parameters
business_id: 613ff620-1c30-43ea-9c0c-25601d3e6fc1
query: Newspaper
| Name | Description |
|---|---|
| business_id required | ID of associated business |
| query required | Name of campaign |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 0,
"total_count": 0
}
}
}
Campaigns - Delete
Successfully deletes a campaign
Request
curl "http://localhost:3000/api/v1/businesses/d3de09a8-239d-4587-b437-2f02f9ef4506/campaigns/31b5cde1-777e-4944-ada5-0841bec7698b" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: corinna@haley.io" \
-H "Authorization: jZSkyxiC22wLksnzCGzs" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/businesses/:business_id/campaigns/:id
DELETE /api/v1/businesses/d3de09a8-239d-4587-b437-2f02f9ef4506/campaigns/31b5cde1-777e-4944-ada5-0841bec7698b
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "311195c9-80ec-45ad-ac01-808ea23d809c",
"type": "campaign",
"attributes": {
"business_id": "d3de09a8-239d-4587-b437-2f02f9ef4506",
"campaign_name": "Lehner-Shields",
"professional_types": [
"creator",
"influencer"
],
"description": "Nesciunt vel et. Voluptatem perferendis laborum. Labore enim praesentium.",
"live_metrics_enabled": false,
"goals": "Ipsum dolor ratione. Dolor accusantium temporibus. Aut enim magni.",
"niche": [
"Politics"
],
"created_by": "3e41e602-591a-400d-b5f1-46e0687db865",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Swaniawski LLC",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
},
{
"id": "1798d9d0-3925-420a-88f7-cf40780ba156",
"type": "campaign",
"attributes": {
"business_id": "d3de09a8-239d-4587-b437-2f02f9ef4506",
"campaign_name": "Schmitt-Bosco",
"professional_types": [
"creator",
"influencer"
],
"description": "Sunt debitis saepe. Eius voluptatem tempora. Sit aliquid porro.",
"live_metrics_enabled": false,
"goals": "Eum quis consequatur. Itaque facere sunt. Ut voluptas odit.",
"niche": [
"Politics"
],
"created_by": "3e41e602-591a-400d-b5f1-46e0687db865",
"status": "draft",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": null
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Swaniawski LLC",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
]
}
when deleting started campaigns
Request
curl "http://localhost:3000/api/v1/businesses/c35d91ae-c3b2-4c87-909e-aba740623b5a/campaigns/501b9e59-1bd3-4e42-b677-995bbdab05f5" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lawana@stoltenberg.io" \
-H "Authorization: ckS85jLXiUNQAsTC75US" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/businesses/:business_id/campaigns/:id
DELETE /api/v1/businesses/c35d91ae-c3b2-4c87-909e-aba740623b5a/campaigns/501b9e59-1bd3-4e42-b677-995bbdab05f5
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "501b9e59-1bd3-4e42-b677-995bbdab05f5",
"type": "campaign",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base You can only delete draft campaigns",
"title": "You can only delete draft campaigns"
}
]
}
With another user's campaign
Request
curl "http://localhost:3000/api/v1/businesses/92c7dab2-7875-40cf-817b-215997e8fc89/campaigns/e3b89db4-de39-40bf-a43c-bc2280bb4894" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: darrin.terry@johnston.io" \
-H "Authorization: eq-rz_Me531zZSnJsJ8x" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/businesses/:business_id/campaigns/:id
DELETE /api/v1/businesses/92c7dab2-7875-40cf-817b-215997e8fc89/campaigns/e3b89db4-de39-40bf-a43c-bc2280bb4894
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Without Authentication
Request
curl "http://localhost:3000/api/v1/businesses/3a64b688-a564-45a6-9e05-2e552ca30126/campaigns/655400ab-9469-4d33-875c-4a6700c8d26e" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/businesses/:business_id/campaigns/:id
DELETE /api/v1/businesses/3a64b688-a564-45a6-9e05-2e552ca30126/campaigns/655400ab-9469-4d33-875c-4a6700c8d26e
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Campaigns - Archive
Successfully archive a campaign
Request
curl "http://localhost:3000/api/v1/businesses/aac7cd05-73e0-4bc3-bcc1-f8d8baa651dd/campaigns/5028cf8c-4406-44aa-972c-c9197830776a/archive" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: sal_reichel@hagenesmcclure.biz" \
-H "Authorization: ZcuJTH62tMohdeZ6B-7B" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:id/archive
PATCH /api/v1/businesses/aac7cd05-73e0-4bc3-bcc1-f8d8baa651dd/campaigns/5028cf8c-4406-44aa-972c-c9197830776a/archive
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "5028cf8c-4406-44aa-972c-c9197830776a",
"type": "campaign",
"attributes": {
"business_id": "aac7cd05-73e0-4bc3-bcc1-f8d8baa651dd",
"campaign_name": "Runte-Flatley",
"professional_types": [
"creator",
"influencer"
],
"description": "Illum quo voluptatibus. Velit aut nihil. Corrupti animi doloribus.",
"live_metrics_enabled": false,
"goals": "Voluptas amet ea. Consequatur praesentium placeat. Amet dolores laboriosam.",
"niche": [
"Politics"
],
"created_by": "0209f621-a335-42ba-ba08-eb0c2ef964f4",
"status": "archived",
"keyword": null,
"hashtag": null,
"start_date": "2021-06-09",
"end_date": "2021-07-19",
"currency": "USD",
"hide_business_name": false,
"hide_jobs": false,
"hide_campaign_name": false,
"hide_budget": false,
"formatted_dates": {
"start_date": "9th June, 2021",
"end_date": "19th July, 2021",
"started_at": null,
"completed_at": null,
"archived_at": "June 09, 2021 07:56"
},
"budget": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"created_at_in_words": "less than a minute",
"campaign_trackers_status": null,
"jobs_count": 0,
"can_archive": true,
"business_name": "Beier, Conroy and Kuphal",
"jobs_pending": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_started": {
"fraction": "0 / 0",
"percentage": 0.0
},
"jobs_completed": {
"fraction": "0 / 0",
"percentage": 0.0
}
}
}
}
when archiving campaign with ongoing jobs
Request
curl "http://localhost:3000/api/v1/businesses/ac235021-4339-4738-936a-992f457f2baa/campaigns/9be0bf92-fc5e-4dc0-bfdc-f2b04bac1089/archive" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: buffy_gottlieb@farrell.info" \
-H "Authorization: HraSZj25E-F8TuzX-g6Y" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/campaigns/:id/archive
PATCH /api/v1/businesses/ac235021-4339-4738-936a-992f457f2baa/campaigns/9be0bf92-fc5e-4dc0-bfdc-f2b04bac1089/archive
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
400 Bad Request
{
"data": {
"errors": {
"detail": "Campaign cannot be archived"
}
}
}
Campaign Deliverables - Get All
Getting a list of campaign's deliverables
Request
curl -g "http://localhost:3000/api/v1/campaigns/c92d378d-2508-489a-a639-e6e0ef409cdc/campaign_deliverables" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: guy@beattykutch.net" \
-H "Authorization: PuM3GJVL14FRxqGNTHvi" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_deliverables
GET /api/v1/campaigns/c92d378d-2508-489a-a639-e6e0ef409cdc/campaign_deliverables
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "9e78ff22-fffd-4ffc-a421-428189a99cc0",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
],
"date_submitted": "2021-06-09",
"proposal_id": "17de6fb7-5fcd-4b43-91ce-28894cb57638",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "2b8cfb33-1cb6-43a9-a068-76001c4d5362",
"fullname": "Moira McKenzie",
"username": "moira-mckenzie-9b00b6ac-be88-4264-84b5-b52582dbc138",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "c5c88489-370a-4f84-9d85-7f9401d11042"
},
"job": {
"id": "ec66a16f-229a-4bc8-9eed-5e0a190fcf94",
"title": "Logo designs",
"description": "Ad sit soluta. Harum neque sapiente. Assumenda cumque qui.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Hilpert LLC",
"business_id": "72c0dc83-c6b6-48db-97e6-23d13a0caffd",
"business_name": "Murphy and Sons",
"business_avg_ratings": 0.0,
"business_wallet_id": "717a2154-c5cf-408d-97aa-fd668db40ec5",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
},
{
"id": "9ed026e8-4d26-4615-a7f0-756e45230f51",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxoWldJMU1UaGlaaTAwTVRkakxUUTFZemN0T0RVME5DMWxOVFZqTmpNNE5EYzRZbVlHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--634db4ed1b8e067fd583f183a09a2c5b2e55b808/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "c894f949-de7e-4230-bdc0-7281de6158df",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "21f2b3f5-f0f3-4776-a07b-f0862d6b6e52",
"fullname": "Norris Hahn",
"username": "norris-hahn-e1af71f1-b531-4b7d-b945-19f3ac2d1899",
"professional_type": "publisher",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "ad0f12c8-503e-46af-905a-f2a64af2e761"
},
"job": {
"id": "e94b5e36-9fed-475a-b777-c9415b335699",
"title": "Logo designs",
"description": "Ut amet modi. Quasi aut necessitatibus. Odio deserunt aliquid.",
"job_type": "publisher",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Hilpert LLC",
"business_id": "72c0dc83-c6b6-48db-97e6-23d13a0caffd",
"business_name": "Murphy and Sons",
"business_avg_ratings": 0.0,
"business_wallet_id": "717a2154-c5cf-408d-97aa-fd668db40ec5",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
},
{
"id": "15e8cf85-4f45-4df3-9a08-88160ecf4c0c",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsxWW1Sak1XVTVOeTA0TVRGbExUUTVNekl0WVRReU1TMWxZMlU1TkRrMU5XWmlPVGtHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--55d17ee49a3ee6d043de5b0bb8478f07269e2f76/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": null,
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "2b8cfb33-1cb6-43a9-a068-76001c4d5362",
"fullname": "Moira McKenzie",
"username": "moira-mckenzie-9b00b6ac-be88-4264-84b5-b52582dbc138",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "c5c88489-370a-4f84-9d85-7f9401d11042"
},
"job": {
"id": "18092927-d99e-4591-a007-891b9b4dd05f",
"title": "Logo designs",
"description": "Sed molestiae laborum. Dolores omnis dicta. Repellat atque qui.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Hilpert LLC",
"business_id": "72c0dc83-c6b6-48db-97e6-23d13a0caffd",
"business_name": "Murphy and Sons",
"business_avg_ratings": 0.0,
"business_wallet_id": "717a2154-c5cf-408d-97aa-fd668db40ec5",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
},
{
"id": "85cbb965-4125-4219-8ef9-f6d6e0c31d52",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
],
"date_submitted": "2021-06-09",
"proposal_id": null,
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "21f2b3f5-f0f3-4776-a07b-f0862d6b6e52",
"fullname": "Norris Hahn",
"username": "norris-hahn-e1af71f1-b531-4b7d-b945-19f3ac2d1899",
"professional_type": "publisher",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "ad0f12c8-503e-46af-905a-f2a64af2e761"
},
"job": {
"id": "91ef456c-b135-4861-a8be-4141605bb6d8",
"title": "Logo designs",
"description": "Consequatur qui consequatur. Quia eius et. Quod rerum quia.",
"job_type": "publisher",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Hilpert LLC",
"business_id": "72c0dc83-c6b6-48db-97e6-23d13a0caffd",
"business_name": "Murphy and Sons",
"business_avg_ratings": 0.0,
"business_wallet_id": "717a2154-c5cf-408d-97aa-fd668db40ec5",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
]
}
With professional user
Request
curl -g "http://localhost:3000/api/v1/campaigns/a66ab3d3-9dfa-4712-b902-622ba667639a/campaign_deliverables" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: brittany.mosciski@collins.co" \
-H "Authorization: ReqZh_vSah9ezD-Tmx27" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_deliverables
GET /api/v1/campaigns/a66ab3d3-9dfa-4712-b902-622ba667639a/campaign_deliverables
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/b831a1be-942b-482a-b390-b5b91dea5f9e/campaign_deliverables" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_deliverables
GET /api/v1/campaigns/b831a1be-942b-482a-b390-b5b91dea5f9e/campaign_deliverables
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Campaign Deliverables - Get One
Getting the deliverable for a job
Request
curl -g "http://localhost:3000/api/v1/campaigns/f478f4cb-0df4-4562-8f98-0e011dabed85/campaign_deliverables/070c71d3-9874-491e-bd17-5651e138afa7" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ezra@abernathy.com" \
-H "Authorization: TDm8LsSqMvx5amk6RaYV" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_deliverables/:id
GET /api/v1/campaigns/f478f4cb-0df4-4562-8f98-0e011dabed85/campaign_deliverables/070c71d3-9874-491e-bd17-5651e138afa7
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "070c71d3-9874-491e-bd17-5651e138afa7",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxsWTJFeFpHSmlOeTB4TUdOakxUUXpZMkV0WVRCbE5TMW1NamRrTWpVek1HTXlPVEVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--bf300fd1e0f38ddb7c1484f99af8d2aa40fda600/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "9a1865ae-3a97-4b8e-a401-af4c9c2227ca",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "792e4660-0c45-4155-a803-864621c47f3f",
"fullname": "Hellen Robel",
"username": "hellen-robel-08882c45-5ca3-48ca-b9ff-c8996e0de800",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "a0b4d325-7c6d-4d57-b5aa-bbf1db22e7fd"
},
"job": {
"id": "49609e69-6828-4543-89b3-47102b8ea6e2",
"title": "Logo designs",
"description": "Illum expedita est. Officia at numquam. Nostrum sit doloremque.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Anderson LLC",
"business_id": "15135cfa-8090-4aa2-b065-841220dcc3a7",
"business_name": "Lockman, Howe and Rutherford",
"business_avg_ratings": 0.0,
"business_wallet_id": "0afcd5ea-424e-4692-9369-5be3a5c8de3b",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
}
When deliverable does not belong to campaign/business
Request
curl -g "http://localhost:3000/api/v1/campaigns/f703c3c5-4aa6-4c9c-b2bd-3cdce13b1ab4/campaign_deliverables/188f9ee3-b448-4021-bcd1-c0bdcf2383c2" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: maire@schimmel.info" \
-H "Authorization: uwrzFos8cVz23-7qii8B" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_deliverables/:id
GET /api/v1/campaigns/f703c3c5-4aa6-4c9c-b2bd-3cdce13b1ab4/campaign_deliverables/188f9ee3-b448-4021-bcd1-c0bdcf2383c2
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/cf42493b-7d4f-4dd0-af64-3091dc7c8abb/campaign_deliverables/b6542475-8eaa-4979-a3b8-ef60032f97a0" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_deliverables/:id
GET /api/v1/campaigns/cf42493b-7d4f-4dd0-af64-3091dc7c8abb/campaign_deliverables/b6542475-8eaa-4979-a3b8-ef60032f97a0
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not available
Request
curl -g "http://localhost:3000/api/v1/campaigns/79457f05-3570-4488-ba7f-235519062eb5/campaign_deliverables/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: anibal_mayer@rath.name" \
-H "Authorization: DwpXNzq63-TNr4c66gJy" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_deliverables/:id
GET /api/v1/campaigns/79457f05-3570-4488-ba7f-235519062eb5/campaign_deliverables/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Campaign Deliverables - Approve And Pay For Deliverables
Successfully approves and pays without iterations
Request
curl "http://localhost:3000/api/v1/campaigns/02458074-2b51-494d-bc1b-98f6bba910c5/campaign_deliverables/6141a7a9-2178-42c9-a45f-f4368951c363/approve" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: nga.harris@beahanankunding.org" \
-H "Authorization: YozUjvpyjXCCmrNZf-Pq" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/campaign_deliverables/:campaign_deliverable_id/approve
PATCH /api/v1/campaigns/02458074-2b51-494d-bc1b-98f6bba910c5/campaign_deliverables/6141a7a9-2178-42c9-a45f-f4368951c363/approve
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_deliverable_id required | Deliverable ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "6141a7a9-2178-42c9-a45f-f4368951c363",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": "36967d75-7911-4d6b-9034-1b2e773fef65",
"status": "approved",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt5TkRnNVlUWXpNaTB6TlRka0xUUTNOMk10WWpjeFpTMW1ORGd4TTJJd1ptVTRZMkVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--e18a6989267686b9f1a9b4c0b222832b99a8da65/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "de835285-8584-4d86-b9c8-6420b4eb23ae",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": "about 8 hours"
},
"professional": {
"id": "0bfeaafe-6b1c-4913-a5fa-eb3123cee0f0",
"fullname": "Johnie Berge",
"username": "johnie-berge-47cd778c-cda3-4e21-a448-39cc06656e0e",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "bc35a4db-a28b-4c25-8b40-3b42a0a22d70"
},
"job": {
"id": "908072c1-39cf-4ad1-ae86-fe8166d856ba",
"title": "Logo designs",
"description": "Dolore nam aliquid. Atque et consequuntur. Rerum quod repellat.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Considine Group",
"business_id": "a44782a0-3be5-4a5c-848c-2d9ab5ab9c23",
"business_name": "Weber-Hansen",
"business_avg_ratings": 0.0,
"business_wallet_id": "5ea70d77-d98e-47c8-814a-b27a02429508",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
}
Successfully approves and pays with iterations
Request
curl "http://localhost:3000/api/v1/campaigns/9ef7a52a-20cd-404f-b507-6c9d3533bcc5/campaign_deliverables/4196fdb7-9f6b-4a4a-bf99-ecb9f91b316d/approve" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: luigi_cormier@walker.net" \
-H "Authorization: Xpx4hax_uunXBMwbrofM" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/campaign_deliverables/:campaign_deliverable_id/approve
PATCH /api/v1/campaigns/9ef7a52a-20cd-404f-b507-6c9d3533bcc5/campaign_deliverables/4196fdb7-9f6b-4a4a-bf99-ecb9f91b316d/approve
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_deliverable_id required | Deliverable ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "4196fdb7-9f6b-4a4a-bf99-ecb9f91b316d",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": "e107661f-c788-43bb-9c9d-0ccd1b2a8e2f",
"status": "approved",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs0TldOaU5URXhaUzFrTWpSakxUUXpOemd0T0dKaFpTMWhNR0kwT0RZMFl6Y3hZelFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--7f0e2da09b9ca99ef99e5c8e92dfa7a4ce782664/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "d1a540c4-38b6-451e-bac6-2aee6b3339d1",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": "about 8 hours"
},
"professional": {
"id": "315cea42-2a7d-4c6b-93b3-3f6a90b8c3d8",
"fullname": "Quinn Gusikowski",
"username": "quinn-gusikowski-4b73dae8-7345-4c24-ad20-115e63531a04",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "6905ce0e-f65f-4dbc-8a83-b64d6c609ce7"
},
"job": {
"id": "d41bb66e-5360-4ef3-a521-b209053e0ddd",
"title": "Logo designs",
"description": "Neque eum provident. Et iusto modi. Voluptates pariatur provident.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Smith Inc",
"business_id": "fbde664a-7fa6-4b3f-93b7-e0cc0c9db997",
"business_name": "Little-Kohler",
"business_avg_ratings": 0.0,
"business_wallet_id": "46a3eadd-243d-4ddc-963d-8e4b6c4fdd9d",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
{
"id": "babbfe67-45eb-4f7b-936c-49b062c7c448",
"type": "iteration",
"attributes": {
"fullname": "Quinn Gusikowski",
"links": [
"www.sportslife.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"created_at": "2021-06-09T07:56:14.090Z",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxrTlRBNU5XSXlNUzFsT0Rsa0xUUmpaamt0T0Rnd01TMWlOelZqTm1RM1pqRTRNVEVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--8447c006f7f26e5845301a2748e713259c6a9923/fruits.jpeg"
},
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxsTldNeFpqWTFPUzFsTkdJM0xUUTBaVGN0WWpka09DMHpOVEkwWm1KaU5EZ3hNMkVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--06689c1bafd53d8b6dbd44a67ed306a8b239deef/doc.pdf"
}
],
"created_at_in_words": "less than a minute"
}
}
]
},
"comments": {
"data": [
{
"id": "1cdf0d3b-9578-46bb-9e8d-a0c6f5d136f4",
"type": "deliverable_comment",
"attributes": {
"fullname": "Henriette Senger",
"created_by": "Business",
"description": "Please change the font colors",
"created_at_in_words": "less than a minute"
}
}
]
}
}
}
}
Professional trying to approve deliverable
Request
curl "http://localhost:3000/api/v1/campaigns/5c910a01-6c4a-4f91-a0a0-ab1262472fc7/campaign_deliverables/8b67e281-bcf0-4659-951d-d64691f01675/approve" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: marvis.franecki@hegmann.info" \
-H "Authorization: y5e7yKR5uxQo_yygffJs" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/campaign_deliverables/:campaign_deliverable_id/approve
PATCH /api/v1/campaigns/5c910a01-6c4a-4f91-a0a0-ab1262472fc7/campaign_deliverables/8b67e281-bcf0-4659-951d-d64691f01675/approve
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_deliverable_id required | Deliverable ID |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Campaign Deliverables - Requesting Changes
Successfully creates an deliverable comment
Request
curl "http://localhost:3000/api/v1/campaigns/b0fa41e4-9db0-49d1-93a8-fec76b8e2c3f/campaign_deliverables/bfc4f567-d70c-406b-898c-88bb263560b1/request_changes" -d '{"comment":{"description":"Officiis reprehenderit qui. Accusantium reiciendis sed. Officiis et quidem."}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: shanti@baileyschinner.biz" \
-H "Authorization: jhG1f3mzKptr116Yzkn6" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/campaign_deliverables/:campaign_deliverable_id/request_changes
POST /api/v1/campaigns/b0fa41e4-9db0-49d1-93a8-fec76b8e2c3f/campaign_deliverables/bfc4f567-d70c-406b-898c-88bb263560b1/request_changes
Accept: application/json
Content-Type: application/json
Parameters
{"comment":{"description":"Officiis reprehenderit qui. Accusantium reiciendis sed. Officiis et quidem."}}
| Name | Description |
|---|---|
| comment[description] required | Text with requested changes |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "bfc4f567-d70c-406b-898c-88bb263560b1",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "changes_requested",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs0WlRaaU5tVmxZUzAxTlRJMUxUUTFPRGd0WW1Ka05DMDFOVFk0TWpSbU1tUm1NRFlHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--6793e59350e6660bf4e36e72e1ba268da7925aa8/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "46ac7e41-6bad-43ee-9768-5eec90f102d3",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "3dab6122-fafc-4ccf-9410-656a474c82a8",
"fullname": "Raymon Blick",
"username": "raymon-blick-08628adb-30ca-485e-9a4b-3a14c52f6763",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "2f67c0f7-42f4-4613-83a3-19ec0719aff3"
},
"job": {
"id": "1ed73232-4c18-4780-826a-c098b20211b0",
"title": "Logo designs",
"description": "Hic odio sint. Assumenda nam rerum. Officiis dolore laborum.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Mertz Inc",
"business_id": "ba6ad102-acaa-454d-a313-e27efdadf591",
"business_name": "Leffler LLC",
"business_avg_ratings": 0.0,
"business_wallet_id": "a3b53086-863b-4c69-9e01-09294a8bf6fe",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
{
"id": "5db36e36-16e8-475e-b588-0f8f998a42ff",
"type": "deliverable_comment",
"attributes": {
"fullname": "Tangela Mertz",
"created_by": "Business",
"description": "Officiis reprehenderit qui. Accusantium reiciendis sed. Officiis et quidem.",
"created_at_in_words": "less than a minute"
}
}
]
}
}
}
}
Without required description
Request
curl "http://localhost:3000/api/v1/campaigns/33a6b1dc-208d-42de-a02a-0e5930e57412/campaign_deliverables/38f78a9f-c483-4f9f-9ef5-53f48292eaa9/request_changes" -d '{"comment":{"description":""}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: thaddeus_rodriguez@gibson.org" \
-H "Authorization: KjuQ23vcQDhTj1yV_XRt" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/campaign_deliverables/:campaign_deliverable_id/request_changes
POST /api/v1/campaigns/33a6b1dc-208d-42de-a02a-0e5930e57412/campaign_deliverables/38f78a9f-c483-4f9f-9ef5-53f48292eaa9/request_changes
Accept: application/json
Content-Type: application/json
Parameters
{"comment":{"description":""}}
| Name | Description |
|---|---|
| comment[description] required | Text with requested changes |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "deliverablecomment",
"errors": [
{
"source": {
"pointer": "/data/attributes/description"
},
"detail": "Description can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/campaigns/858d5526-928b-466a-81dc-d440af8cedd0/campaign_deliverables/484ead78-140a-4690-85f1-b1b728bc565e/request_changes" -d '{"comment":{"description":"Id eos vero. Ad sit perspiciatis. Ipsam quia laboriosam."}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/campaign_deliverables/:campaign_deliverable_id/request_changes
POST /api/v1/campaigns/858d5526-928b-466a-81dc-d440af8cedd0/campaign_deliverables/484ead78-140a-4690-85f1-b1b728bc565e/request_changes
Accept: application/json
Content-Type: application/json
Parameters
{"comment":{"description":"Id eos vero. Ad sit perspiciatis. Ipsam quia laboriosam."}}
| Name | Description |
|---|---|
| comment[description] required | Text with requested changes |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Campaign Proposals - Get All
Getting a list of campaign's proposals
Request
curl -g "http://localhost:3000/api/v1/campaigns/b1a83621-af29-456c-b296-9218ef53e2fb/campaign_proposals" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: alia@goodwin.co" \
-H "Authorization: x1SkPF_9hV9sWiyj513-" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_proposals
GET /api/v1/campaigns/b1a83621-af29-456c-b296-9218ef53e2fb/campaign_proposals
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "48b43105-5ba3-409b-8b7b-b3db677d16df",
"type": "proposal",
"attributes": {
"summary": "Architecto tempora saepe. Exercitationem ut maiores. Et eum eaque.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "12ceecdf-b820-49cc-8018-bf3a86f5a631",
"fullname": "Marci Batz",
"username": "marci-batz-7e2324ed-6fc9-45d9-89ef-220ff2052290",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "71177c90-9d7a-42f7-a9e5-e361a723c7f8",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "006b0c37-ea03-426f-a1eb-e1dddc5e3c02",
"title": "Logo designs",
"description": "Placeat aspernatur dolorem. Optio praesentium natus. Dolorem cum commodi.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Crona-Kassulke",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "2d71fa3b-ac3c-4e86-8aa3-fce264b821b4",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
},
{
"id": "919e5031-1705-47d5-ad0d-116351bd5b11",
"type": "proposal",
"attributes": {
"summary": "Ut ut error. Quaerat odio quo. Repellendus perferendis eligendi.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "12ceecdf-b820-49cc-8018-bf3a86f5a631",
"fullname": "Marci Batz",
"username": "marci-batz-7e2324ed-6fc9-45d9-89ef-220ff2052290",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "71177c90-9d7a-42f7-a9e5-e361a723c7f8",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "5cbafb5b-657c-4c40-b8d6-6298fe6d3b77",
"title": "Logo designs",
"description": "Sed et omnis. Omnis atque eum. Et dolore nihil.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Crona-Kassulke",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "2d71fa3b-ac3c-4e86-8aa3-fce264b821b4",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
},
{
"id": "5d7da5d8-34ba-49e9-b1e5-440217242b46",
"type": "proposal",
"attributes": {
"summary": "Tenetur quas qui. Sint laborum natus. Autem maiores ut.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "f5112cdf-7402-40cc-bad9-cdbdc41b356b",
"fullname": "Deloise Bailey",
"username": "deloise-bailey-1b4bb505-2b6b-470c-8ffe-fbf92718940a",
"professional_type": "publisher",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "251f1a2c-57df-4fd5-bc05-fc7734a5d5ff",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "c99728fb-39e4-4b9b-931e-1b8a5217d44e",
"title": "Logo designs",
"description": "Eaque et vel. Architecto modi beatae. Officia explicabo iusto.",
"job_type": "publisher",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Crona-Kassulke",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "2d71fa3b-ac3c-4e86-8aa3-fce264b821b4",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
},
{
"id": "169c6e85-dbd5-499e-b9fa-60cefb452df7",
"type": "proposal",
"attributes": {
"summary": "Ducimus provident aut. Eveniet ut repellendus. Doloribus omnis perferendis.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "f5112cdf-7402-40cc-bad9-cdbdc41b356b",
"fullname": "Deloise Bailey",
"username": "deloise-bailey-1b4bb505-2b6b-470c-8ffe-fbf92718940a",
"professional_type": "publisher",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "251f1a2c-57df-4fd5-bc05-fc7734a5d5ff",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "7127401c-fc40-4ab2-848f-0796984e595a",
"title": "Logo designs",
"description": "Enim quisquam minus. Voluptatem nesciunt soluta. Ducimus distinctio doloribus.",
"job_type": "publisher",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Crona-Kassulke",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "2d71fa3b-ac3c-4e86-8aa3-fce264b821b4",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
}
]
}
With professional user
Request
curl -g "http://localhost:3000/api/v1/campaigns/79654d84-8b1c-4d27-9def-89f55b446ef2/campaign_proposals" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: gregorio.mcclure@kovacek.info" \
-H "Authorization: H4qwb1YxAE4R9QuzU6dy" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_proposals
GET /api/v1/campaigns/79654d84-8b1c-4d27-9def-89f55b446ef2/campaign_proposals
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/724ce546-0cb6-41fb-9788-d7a46b7e1e82/campaign_proposals" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_proposals
GET /api/v1/campaigns/724ce546-0cb6-41fb-9788-d7a46b7e1e82/campaign_proposals
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Campaign Proposals - Get One
Getting the proposal for a job
Request
curl -g "http://localhost:3000/api/v1/campaigns/4454980a-d597-4fcc-bfc0-4ff2dda7e868/campaign_proposals/2269aab6-2c92-4756-9a1c-a0c067210fba" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tomas.wintheiser@watsica.name" \
-H "Authorization: HyCZ_uShZE4EB9Bz4sqs" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_proposals/:id
GET /api/v1/campaigns/4454980a-d597-4fcc-bfc0-4ff2dda7e868/campaign_proposals/2269aab6-2c92-4756-9a1c-a0c067210fba
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "2269aab6-2c92-4756-9a1c-a0c067210fba",
"type": "proposal",
"attributes": {
"summary": "Possimus fugiat quos. Molestiae et quibusdam. Voluptate veniam veritatis.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "9ee67fe2-5d3e-4079-bd33-3b7ae34c3bc6",
"fullname": "Ellsworth Gutkowski",
"username": "ellsworth-gutkowski-55e7802c-e990-4d4b-934a-ee90978d4956",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "c710a470-351b-4a8d-9c0e-71397460f16e",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "2d3344e7-44cd-40de-a843-e705f015b688",
"title": "Logo designs",
"description": "Voluptatem quia nihil. Cum aut mollitia. Sint corporis expedita.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Fritsch LLC",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "30ac354c-5594-404c-b64c-a7919b792329",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
}
}
When proposal does not belong to campaign/business
Request
curl -g "http://localhost:3000/api/v1/campaigns/84266764-47a9-4898-ad5c-69873dd0ffc1/campaign_proposals/0e844176-87d6-408b-92be-11713456ec31" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: hortensia@runolfon.org" \
-H "Authorization: YXjk4AJqAwR59sAVmp5_" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_proposals/:id
GET /api/v1/campaigns/84266764-47a9-4898-ad5c-69873dd0ffc1/campaign_proposals/0e844176-87d6-408b-92be-11713456ec31
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/611b2081-da26-453d-b7fd-678ccb59628a/campaign_proposals/815f878c-c703-4dc7-b298-57c53bd4fca2" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_proposals/:id
GET /api/v1/campaigns/611b2081-da26-453d-b7fd-678ccb59628a/campaign_proposals/815f878c-c703-4dc7-b298-57c53bd4fca2
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not available
Request
curl -g "http://localhost:3000/api/v1/campaigns/027d25d4-d147-47f6-b4d8-de92232fc20b/campaign_proposals/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: madelene_reichert@luettgen.org" \
-H "Authorization: Sy_KXjaDysDg3hoyPx6L" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_proposals/:id
GET /api/v1/campaigns/027d25d4-d147-47f6-b4d8-de92232fc20b/campaign_proposals/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Campaign Proposals - Accept Proposals
Successful with with valid params
Request
curl "http://localhost:3000/api/v1/campaigns/eb9aa856-5fb4-4dbb-9ae7-0913a31d277a/campaign_proposals/2624e86c-636e-4621-88d6-131ae5a833c4/accept" -d '{}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: scottie@bogisich.co" \
-H "Authorization: vTKG5x1RXzaT2E3ryWs5" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/campaign_proposals/:campaign_proposal_id/accept
POST /api/v1/campaigns/eb9aa856-5fb4-4dbb-9ae7-0913a31d277a/campaign_proposals/2624e86c-636e-4621-88d6-131ae5a833c4/accept
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_proposal_id required | Proposal ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"publishableKey": "pk_test_vP2x6sAzsLbiwES5BQebyPms00ccrir58o",
"clientSecret": "pi_1EwXFB2eZvKYlo2CggNnFBo8_secret_vOMkpqZu8ca7hxhfiO80tpT3v",
"id": "test_pi_6"
}
Failure when plan limit is reached
Request
curl "http://localhost:3000/api/v1/campaigns/a5846ced-f373-42b4-951f-c8fb68a775bf/campaign_proposals/b18f25cc-9f94-496d-aba3-a336111d7666/accept" -d '{}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: wilbur.waters@krajcikmohr.info" \
-H "Authorization: yKqxAgY9Nwhz3ZuydLYz" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/campaign_proposals/:campaign_proposal_id/accept
POST /api/v1/campaigns/a5846ced-f373-42b4-951f-c8fb68a775bf/campaign_proposals/b18f25cc-9f94-496d-aba3-a336111d7666/accept
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_proposal_id required | Proposal ID |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "b18f25cc-9f94-496d-aba3-a336111d7666",
"type": "proposal",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base Oops, Plan limit reached. Kindly upgrade",
"title": "Oops, Plan limit reached. Kindly upgrade"
}
]
}
Failure when current user is not an admin
Request
curl "http://localhost:3000/api/v1/campaigns/4feebbba-3ac3-454b-86f3-56fb70c0ea3e/campaign_proposals/ffea8cd6-5ff1-4b62-b692-77de2143a1fe/accept" -d '{}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lester@olson.net" \
-H "Authorization: zbA9dzRW5_thazpwFKy1" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/campaign_proposals/:campaign_proposal_id/accept
POST /api/v1/campaigns/4feebbba-3ac3-454b-86f3-56fb70c0ea3e/campaign_proposals/ffea8cd6-5ff1-4b62-b692-77de2143a1fe/accept
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_proposal_id required | Proposal ID |
Response
Content-Type: application/json; charset=utf-8
403 Forbidden
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Campaign Proposals - Reject Proposals
Successful with with valid params
Request
curl "http://localhost:3000/api/v1/campaigns/af424e92-9732-4feb-aa81-f015648b7437/campaign_proposals/f5426b86-f0fa-4016-8ec7-065a2f790028/reject" -d '{"rejection_reasons":"Poor rating"}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: carlo_littel@davis.net" \
-H "Authorization: GTG-smKa45K3xjsRBq6J" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/campaign_proposals/:campaign_proposal_id/reject
PATCH /api/v1/campaigns/af424e92-9732-4feb-aa81-f015648b7437/campaign_proposals/f5426b86-f0fa-4016-8ec7-065a2f790028/reject
Accept: application/json
Content-Type: application/json
Parameters
{"rejection_reasons":"Poor rating"}
| Name | Description |
|---|---|
| campaign_proposal_id required | Proposal ID |
| rejection_reasons required | Status - only rejected |
Response
Content-Type: application/json
200 OK
Without rejection reasons
Request
curl "http://localhost:3000/api/v1/campaigns/f1a88736-3997-426b-8881-e4e17a36e6aa/campaign_proposals/5dd65cc5-7529-483f-9d99-be182ef157c0/reject" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: cary.hegmann@botsfordwaelchi.info" \
-H "Authorization: xVEuP6z2JpxtyRxa1kJZ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/campaign_proposals/:campaign_proposal_id/reject
PATCH /api/v1/campaigns/f1a88736-3997-426b-8881-e4e17a36e6aa/campaign_proposals/5dd65cc5-7529-483f-9d99-be182ef157c0/reject
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_proposal_id required | Proposal ID |
| rejection_reasons required | Status - only rejected |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "5dd65cc5-7529-483f-9d99-be182ef157c0",
"type": "proposal",
"errors": [
{
"source": {
"pointer": "/data/attributes/rejection_reasons"
},
"detail": "Rejection_reasons can't be blank",
"title": "can't be blank"
}
]
}
Professional trying to reject proposal
Request
curl "http://localhost:3000/api/v1/campaigns/00a838b2-fb9c-497a-974a-8841496fe9f7/campaign_proposals/ef7cf4aa-ffe5-4d6a-b327-6b18c5459656/reject" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: claretta@feil.info" \
-H "Authorization: _vtiPtNxXxzt4GYDrusw" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/campaign_proposals/:campaign_proposal_id/reject
PATCH /api/v1/campaigns/00a838b2-fb9c-497a-974a-8841496fe9f7/campaign_proposals/ef7cf4aa-ffe5-4d6a-b327-6b18c5459656/reject
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| campaign_proposal_id required | Proposal ID |
| rejection_reasons required | Status - only rejected |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Campaign Trackers - Get All
Getting all tracker for a campaign
Request
curl -g "http://localhost:3000/api/v1/campaigns/64a108f0-22af-4368-924d-875d4ec6d64c/campaign_trackers" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: delphine@donnelly.com" \
-H "Authorization: JY4ZFw8yH3yyTJy9PiTK" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers
GET /api/v1/campaigns/64a108f0-22af-4368-924d-875d4ec6d64c/campaign_trackers
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "90f79de2-7aed-427d-8ccf-cbbd26fafc45",
"type": "campaign_tracker",
"attributes": {
"campaign_id": "64a108f0-22af-4368-924d-875d4ec6d64c",
"tracking_term": "#OhYesMember",
"tracking_type": "hashtag",
"status": "active"
}
},
{
"id": "b2fedffa-7960-4123-9009-c0ed19ad6d94",
"type": "campaign_tracker",
"attributes": {
"campaign_id": "64a108f0-22af-4368-924d-875d4ec6d64c",
"tracking_term": "OhYesMember",
"tracking_type": "keyword",
"status": "active"
}
}
]
}
With professional user
Request
curl -g "http://localhost:3000/api/v1/campaigns/6a825077-5637-4d00-91b9-d5535d6d1d55/campaign_trackers" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: sherill@bogisichwindler.com" \
-H "Authorization: Tczo4SHj9RuWeLCUTm31" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers
GET /api/v1/campaigns/6a825077-5637-4d00-91b9-d5535d6d1d55/campaign_trackers
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/208fee54-1542-4499-b417-2c6b255feae5/campaign_trackers" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers
GET /api/v1/campaigns/208fee54-1542-4499-b417-2c6b255feae5/campaign_trackers
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Campaign Trackers - Get One
Twitter Flow - Getting a campaign_tracker
Request
curl -g "http://localhost:3000/api/v1/campaigns/0aaf6db1-23a5-42bd-9500-bd031e31b18d/campaign_trackers/f45ec4ab-7e47-421a-bba6-41818fc64962?provider=twitter" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: hugo@dubuquekeebler.co" \
-H "Authorization: 4xrL9FypSJw7PafEJuBM" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:id
GET /api/v1/campaigns/0aaf6db1-23a5-42bd-9500-bd031e31b18d/campaign_trackers/f45ec4ab-7e47-421a-bba6-41818fc64962?provider=twitter
Accept: application/json
Content-Type: application/json
Parameters
provider: twitter
| Name | Description |
|---|---|
| provider required | Provider in lowercase |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "7c3d2390-4787-4d7a-9039-91dd537a5dcc",
"type": "campaign_twitter_tracker",
"attributes": {
"campaign_id": "0aaf6db1-23a5-42bd-9500-bd031e31b18d",
"tracking_term": "#OhYesMember",
"tracking_type": "hashtag",
"campaign_tracker_status": "active",
"related_hashtags": {
},
"related_keywords": [
{
"text": "full",
"frequency": 1
},
{
"text": "text",
"frequency": 1
}
],
"related_urls": {
},
"total_engagement": 1035,
"users_count": 1,
"posts_count": 1,
"impressions": 4500,
"sentiments": {
"neutral": 100.0
},
"posts_by_date": [
{
"id": "c1587e40-bdcc-49d9-bd8c-078dc719d50b",
"avatar": "http://pbg.com/profile_img",
"region": null,
"country": null,
"post_id": "244111636544225280",
"post_url": "http:twitter.com/ki",
"provider": "twitter",
"username": "Omenuko Ikemba",
"post_text": "full text",
"post_type": "quote",
"sentiment": "neutral",
"engagement": 1035,
"updated_at": "2021-06-09T07:56:33.295Z",
"likes_count": 909,
"views_count": null,
"created_date": "2021-06-08T07:56:33.285Z",
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"campaign_influencer_id": "9f6120ca-ac68-4034-98e0-023fcf86ddc7",
"formatted_created_date": "Jun 8, 2021 08:56 AM",
"campaign_twitter_tracker_id": "7c3d2390-4787-4d7a-9039-91dd537a5dcc",
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": null
}
],
"posts_by_engagement": [
{
"id": "c1587e40-bdcc-49d9-bd8c-078dc719d50b",
"avatar": "http://pbg.com/profile_img",
"region": null,
"country": null,
"post_id": "244111636544225280",
"post_url": "http:twitter.com/ki",
"provider": "twitter",
"username": "Omenuko Ikemba",
"post_text": "full text",
"post_type": "quote",
"sentiment": "neutral",
"engagement": 1035,
"updated_at": "2021-06-09T07:56:33.295Z",
"likes_count": 909,
"views_count": null,
"created_date": "2021-06-08T07:56:33.285Z",
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"campaign_influencer_id": "9f6120ca-ac68-4034-98e0-023fcf86ddc7",
"formatted_created_date": "Jun 8, 2021 08:56 AM",
"campaign_twitter_tracker_id": "7c3d2390-4787-4d7a-9039-91dd537a5dcc",
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": null
}
],
"reach": 4500,
"influencers_by_engagement": [
{
"name": "Omenuko Ikemba",
"provider": "twitter",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"posts_count": 1,
"followers_count": 9000,
"total_engagement": 1035,
"profile_image_url": "http://pbg.com/profile_img"
}
],
"influencers_by_frequency": [
{
"name": "Omenuko Ikemba",
"provider": "twitter",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"posts_count": 1,
"followers_count": 9000,
"total_engagement": 1035,
"profile_image_url": "http://pbg.com/profile_img"
}
],
"data_processing_completed": true,
"can_download_report": true
}
}
}
Instagram Flow - Getting a campaign_tracker
Request
curl -g "http://localhost:3000/api/v1/campaigns/7888886e-f74a-4645-b131-1e15f0dc4d7e/campaign_trackers/bdde7ba1-4e02-4c98-b155-df487c06ec06?provider=instagram" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: shirley_hammes@lebsack.biz" \
-H "Authorization: P5B-FtJ3TMnKy6xMzqeV" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:id
GET /api/v1/campaigns/7888886e-f74a-4645-b131-1e15f0dc4d7e/campaign_trackers/bdde7ba1-4e02-4c98-b155-df487c06ec06?provider=instagram
Accept: application/json
Content-Type: application/json
Parameters
provider: instagram
| Name | Description |
|---|---|
| provider required | Provider in lowercase |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "89ce62d8-7abf-4628-9eea-a20ea8675376",
"type": "campaign_instagram_tracker",
"attributes": {
"campaign_id": "7888886e-f74a-4645-b131-1e15f0dc4d7e",
"tracking_term": "#OhYesMember",
"tracking_type": "hashtag",
"campaign_tracker_status": "active",
"related_hashtags": [
{
"text": "#bluebottle",
"frequency": 2
},
{
"text": "#oceanblue",
"frequency": 1
},
{
"text": "#oceanbluelemonade",
"frequency": 1
},
{
"text": "#lemonade",
"frequency": 1
},
{
"text": "#blue",
"frequency": 1
},
{
"text": "#bluedrink",
"frequency": 1
},
{
"text": "#blueaesthetic",
"frequency": 1
},
{
"text": "#aestheticblue",
"frequency": 1
},
{
"text": "#aesthetic",
"frequency": 1
},
{
"text": "#yellow",
"frequency": 1
}
],
"related_keywords": [
{
"text": "pretty",
"frequency": 1
},
{
"text": "🤷🏻♀️",
"frequency": 1
},
{
"text": "sweet",
"frequency": 1
},
{
"text": "sour!",
"frequency": 1
},
{
"text": "inspired",
"frequency": 1
},
{
"text": "green_toons_",
"frequency": 1
},
{
"text": "brings",
"frequency": 1
},
{
"text": "memories",
"frequency": 1
},
{
"text": "good",
"frequency": 1
},
{
"text": "ole",
"frequency": 1
}
],
"related_urls": {
},
"total_engagement": 130,
"users_count": 4,
"posts_count": 4,
"impressions": 1000,
"sentiments": {
"neutral": 25.0,
"negative": 25.0,
"positive": 50.0
},
"posts_by_date": [
{
"id": "92f8197f-0f08-4cce-9d6d-d096e07c4778",
"avatar": null,
"region": null,
"country": null,
"post_id": "17898906232530244",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"post_type": "IMAGE",
"sentiment": "neutral",
"engagement": 2,
"updated_at": "2021-06-09T07:56:33.797Z",
"likes_count": 1,
"views_count": null,
"created_date": "2020-08-11T09:28:40.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "bc030afe-705f-4ca3-b9db-5c741cde4b91",
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
},
{
"id": "59f0ed5f-822e-4a26-8ba5-3995e37beaef",
"avatar": null,
"region": null,
"country": null,
"post_id": "18109911793157694",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "Sweet sour!",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"engagement": 3,
"updated_at": "2021-06-09T07:56:33.810Z",
"likes_count": 3,
"views_count": null,
"created_date": "2020-08-11T07:53:56.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "f2d0686f-96a3-4c38-b1f8-be39e9dde2c4",
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
},
{
"id": "906f93c7-6941-4141-a036-3b6a6dcc7d97",
"avatar": null,
"region": null,
"country": null,
"post_id": "17866774861955240",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"engagement": 69,
"updated_at": "2021-06-09T07:56:33.824Z",
"likes_count": 65,
"views_count": null,
"created_date": "2020-08-11T07:04:26.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "182112e3-fcd7-482e-8719-948ceb97180f",
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
},
{
"id": "7c3adb67-1f14-4ba5-8473-910cf54688c9",
"avatar": null,
"region": null,
"country": null,
"post_id": "18029592184301103",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"engagement": 56,
"updated_at": "2021-06-09T07:56:33.838Z",
"likes_count": 51,
"views_count": null,
"created_date": "2020-08-11T04:29:07.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "14298f36-fbc2-445d-990e-6be6cd48258d",
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
}
],
"posts_by_engagement": [
{
"id": "906f93c7-6941-4141-a036-3b6a6dcc7d97",
"avatar": null,
"region": null,
"country": null,
"post_id": "17866774861955240",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"engagement": 69,
"updated_at": "2021-06-09T07:56:33.824Z",
"likes_count": 65,
"views_count": null,
"created_date": "2020-08-11T07:04:26.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "182112e3-fcd7-482e-8719-948ceb97180f",
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
},
{
"id": "7c3adb67-1f14-4ba5-8473-910cf54688c9",
"avatar": null,
"region": null,
"country": null,
"post_id": "18029592184301103",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"engagement": 56,
"updated_at": "2021-06-09T07:56:33.838Z",
"likes_count": 51,
"views_count": null,
"created_date": "2020-08-11T04:29:07.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "14298f36-fbc2-445d-990e-6be6cd48258d",
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
},
{
"id": "59f0ed5f-822e-4a26-8ba5-3995e37beaef",
"avatar": null,
"region": null,
"country": null,
"post_id": "18109911793157694",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "Sweet sour!",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"engagement": 3,
"updated_at": "2021-06-09T07:56:33.810Z",
"likes_count": 3,
"views_count": null,
"created_date": "2020-08-11T07:53:56.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "f2d0686f-96a3-4c38-b1f8-be39e9dde2c4",
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
},
{
"id": "92f8197f-0f08-4cce-9d6d-d096e07c4778",
"avatar": null,
"region": null,
"country": null,
"post_id": "17898906232530244",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"provider": "instagram",
"username": "Instagram Account",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"post_type": "IMAGE",
"sentiment": "neutral",
"engagement": 2,
"updated_at": "2021-06-09T07:56:33.797Z",
"likes_count": 1,
"views_count": null,
"created_date": "2020-08-11T09:28:40.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"campaign_influencer_id": "bc030afe-705f-4ca3-b9db-5c741cde4b91",
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": null,
"campaign_instagram_tracker_id": "89ce62d8-7abf-4628-9eea-a20ea8675376"
}
],
"reach": 1000,
"influencers_by_engagement": [
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17866774861955240",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 69,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18029592184301103",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 56,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18109911793157694",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 3,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17898906232530244",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 2,
"profile_image_url": null
}
],
"influencers_by_frequency": [
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17898906232530244",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 2,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18109911793157694",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 3,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17866774861955240",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 69,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18029592184301103",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 56,
"profile_image_url": null
}
],
"data_processing_completed": true,
"can_download_report": true
}
}
}
Youtube Flow - Getting a campaign_tracker
Request
curl -g "http://localhost:3000/api/v1/campaigns/0bf843db-4daa-49cb-b47d-38c1e2f53fc3/campaign_trackers/5ab7ab0b-d5d7-4bdd-9bf9-29384d5c57e1?provider=youtube" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: truman@turcotteheller.net" \
-H "Authorization: AuQtezLDpJQDYUnsGkLh" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:id
GET /api/v1/campaigns/0bf843db-4daa-49cb-b47d-38c1e2f53fc3/campaign_trackers/5ab7ab0b-d5d7-4bdd-9bf9-29384d5c57e1?provider=youtube
Accept: application/json
Content-Type: application/json
Parameters
provider: youtube
| Name | Description |
|---|---|
| provider required | Provider in lowercase |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "e3cf0360-89b5-43a7-8fc2-f384a5bc99da",
"type": "campaign_youtube_tracker",
"attributes": {
"campaign_id": "0bf843db-4daa-49cb-b47d-38c1e2f53fc3",
"tracking_term": "#OhYesMember",
"tracking_type": "hashtag",
"campaign_tracker_status": "active",
"related_hashtags": [
{
"text": "#gojulie",
"frequency": 1
},
{
"text": "#julie4president",
"frequency": 1
}
],
"related_keywords": [
{
"text": "song",
"frequency": 1
},
{
"text": "-",
"frequency": 1
},
{
"text": "vote",
"frequency": 1
}
],
"related_urls": {
},
"total_engagement": 695199,
"users_count": 1,
"posts_count": 1,
"impressions": 4500,
"sentiments": {
"neutral": 100.0
},
"posts_by_date": [
{
"id": "626f1065-5c90-4b85-b649-d6c20e65117d",
"avatar": "http://pbgyu.com/profile_img",
"region": null,
"country": null,
"post_id": "vYilNc",
"post_url": "https://www.youtube.com/embed/vYilNc",
"provider": "youtube",
"username": "Odinma Umah",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"post_type": "video",
"sentiment": "neutral",
"engagement": 695199,
"updated_at": "2021-06-09T07:56:34.612Z",
"likes_count": 10100,
"views_count": 677099,
"created_date": "2021-06-07T07:56:34.317Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"campaign_influencer_id": "b51fde3e-1c53-4d52-8f36-fd08db5dc76b",
"formatted_created_date": "Jun 7, 2021 08:56 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": "e3cf0360-89b5-43a7-8fc2-f384a5bc99da",
"campaign_instagram_tracker_id": null
}
],
"posts_by_engagement": [
{
"id": "626f1065-5c90-4b85-b649-d6c20e65117d",
"avatar": "http://pbgyu.com/profile_img",
"region": null,
"country": null,
"post_id": "vYilNc",
"post_url": "https://www.youtube.com/embed/vYilNc",
"provider": "youtube",
"username": "Odinma Umah",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"post_type": "video",
"sentiment": "neutral",
"engagement": 695199,
"updated_at": "2021-06-09T07:56:34.612Z",
"likes_count": 10100,
"views_count": 677099,
"created_date": "2021-06-07T07:56:34.317Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"campaign_influencer_id": "b51fde3e-1c53-4d52-8f36-fd08db5dc76b",
"formatted_created_date": "Jun 7, 2021 08:56 AM",
"campaign_twitter_tracker_id": null,
"campaign_youtube_tracker_id": "e3cf0360-89b5-43a7-8fc2-f384a5bc99da",
"campaign_instagram_tracker_id": null
}
],
"reach": 4500,
"influencers_by_engagement": [
{
"name": "Odinma Umah",
"provider": "youtube",
"username": "UcGQ00Rvc",
"description": "",
"posts_count": 1,
"followers_count": 9000,
"total_engagement": 695199,
"profile_image_url": "http://pbgyu.com/profile_img"
}
],
"influencers_by_frequency": [
{
"name": "Odinma Umah",
"provider": "youtube",
"username": "UcGQ00Rvc",
"description": "",
"posts_count": 1,
"followers_count": 9000,
"total_engagement": 695199,
"profile_image_url": "http://pbgyu.com/profile_img"
}
],
"data_processing_completed": true,
"can_download_report": true
}
}
}
When campaign tracker does not belong to business
Request
curl -g "http://localhost:3000/api/v1/campaigns/0e8033f9-2947-45b6-a3fb-c22151b14012/campaign_trackers/06d8aa15-c374-47db-9e38-99aa9e062813" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: quincy@torp.org" \
-H "Authorization: 9sDhscfn2Xdyg7hNo1oD" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:id
GET /api/v1/campaigns/0e8033f9-2947-45b6-a3fb-c22151b14012/campaign_trackers/06d8aa15-c374-47db-9e38-99aa9e062813
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| provider required | Provider in lowercase |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/43f2431a-3c14-47e8-b12c-a995af0d878b/campaign_trackers/b4769957-ffac-4835-9a2a-fc29a4b258db" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:id
GET /api/v1/campaigns/43f2431a-3c14-47e8-b12c-a995af0d878b/campaign_trackers/b4769957-ffac-4835-9a2a-fc29a4b258db
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| provider required | Provider in lowercase |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When campaign_tracker_id is not available
Request
curl -g "http://localhost:3000/api/v1/campaigns/0e1116de-5fa5-4395-904b-14e1587d1939/campaign_trackers/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: fidel_keebler@hirthe.com" \
-H "Authorization: 9Nkw5YBspZw1sbnXrPJy" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:id
GET /api/v1/campaigns/0e1116de-5fa5-4395-904b-14e1587d1939/campaign_trackers/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| provider required | Provider in lowercase |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Campaign Trackers - Influencers
Twitter Flow - Successful with valid params
Request
curl -g "http://localhost:3000/api/v1/campaigns/78605964-d330-421b-b796-4f9c12475416/campaign_trackers/0f2fe1ee-7123-4dd3-b32d-788316880ddf/influencers?provider=twitter&sort_term=eng_desc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jimmie.mclaughlin@homenick.com" \
-H "Authorization: 1QfxnegJZanqFpQMsCNw" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/influencers
GET /api/v1/campaigns/78605964-d330-421b-b796-4f9c12475416/campaign_trackers/0f2fe1ee-7123-4dd3-b32d-788316880ddf/influencers?provider=twitter&sort_term=eng_desc
Accept: application/json
Content-Type: application/json
Parameters
provider: twitter
sort_term: eng_desc
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| provider required | Provider in lowercase |
| sort_term | influencers by engagements,impressions or reach |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "adb84ea3-e023-4bb2-bf9e-b82dba67f563",
"type": "campaign_influencer",
"attributes": {
"provider": "twitter",
"username": "Omeni",
"name": "Omenuko Ikemba",
"profile_image_url": "http://pbg.com/profile_img",
"description": "Planning, Executing, Delivery",
"location": "Kite",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 1035,
"impressions": 4500.0,
"reach": 4500.0,
"posts": {
"data": [
{
"id": "a0170d42-dd42-4efa-881e-81f5a171e2c8",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "adb84ea3-e023-4bb2-bf9e-b82dba67f563",
"post_id": "244111636544225280",
"formatted_created_date": "Jun 8, 2021 08:56 AM",
"post_text": "full text",
"created_date": "2021-06-08T07:56:35.666Z",
"post_url": "http:twitter.com/ki",
"post_type": "quote",
"sentiment": "neutral",
"likes_count": 909,
"views_count": null,
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"engagement": 1035,
"provider": "twitter",
"influencer": {
"provider": "twitter",
"name": "Omenuko Ikemba",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"profile_image_url": "http://pbg.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 1035
}
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Instagram Flow - Successful with valid params
Request
curl -g "http://localhost:3000/api/v1/campaigns/390b510b-560e-4cb6-8584-8a29ffd0169d/campaign_trackers/d21955e3-f856-48e6-b639-8bfca1f5f549/influencers?provider=instagram&sort_term=reach_asc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: burl@schaeferauer.com" \
-H "Authorization: biQMV3ztSNGkoi-Wt3WH" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/influencers
GET /api/v1/campaigns/390b510b-560e-4cb6-8584-8a29ffd0169d/campaign_trackers/d21955e3-f856-48e6-b639-8bfca1f5f549/influencers?provider=instagram&sort_term=reach_asc
Accept: application/json
Content-Type: application/json
Parameters
provider: instagram
sort_term: reach_asc
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| provider required | Provider in lowercase |
| sort_term | influencers by engagements,impressions or reach |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "4b52c929-3f67-443e-9020-74833d981ce4",
"type": "campaign_influencer",
"attributes": {
"provider": "instagram",
"username": "17898906232530244",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 2,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "c5ee3883-b2fe-4124-9615-d338c84a3f43",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "4b52c929-3f67-443e-9020-74833d981ce4",
"post_id": "17898906232530244",
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"created_date": "2020-08-11T09:28:40.000Z",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"post_type": "IMAGE",
"sentiment": "neutral",
"likes_count": 1,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 2,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17898906232530244",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 2
}
}
}
]
}
}
},
{
"id": "e9aa05c2-2973-4aff-b70a-9b033b04ffe5",
"type": "campaign_influencer",
"attributes": {
"provider": "instagram",
"username": "18109911793157694",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 3,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "949689b8-7a9e-4ea4-969e-833f52ebc18b",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "e9aa05c2-2973-4aff-b70a-9b033b04ffe5",
"post_id": "18109911793157694",
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"post_text": "Sweet sour!",
"created_date": "2020-08-11T07:53:56.000Z",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"likes_count": 3,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 3,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18109911793157694",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 3
}
}
}
]
}
}
},
{
"id": "87bf384c-6daf-4a66-8f5b-99beb9652f4c",
"type": "campaign_influencer",
"attributes": {
"provider": "instagram",
"username": "17866774861955240",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 69,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "055baf6a-fb06-4cd3-b454-b7a1ee534072",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "87bf384c-6daf-4a66-8f5b-99beb9652f4c",
"post_id": "17866774861955240",
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"created_date": "2020-08-11T07:04:26.000Z",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 65,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 69,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17866774861955240",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 69
}
}
}
]
}
}
},
{
"id": "1284cbac-75a1-4be9-b673-29dcd8c05fd3",
"type": "campaign_influencer",
"attributes": {
"provider": "instagram",
"username": "18029592184301103",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 56,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "e13bc178-8bb4-4b09-8f37-7c837b53d90e",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "1284cbac-75a1-4be9-b673-29dcd8c05fd3",
"post_id": "18029592184301103",
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"created_date": "2020-08-11T04:29:07.000Z",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 51,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 56,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18029592184301103",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 56
}
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Youtube Flow - Successful with valid params
Request
curl -g "http://localhost:3000/api/v1/campaigns/73d44a12-e6fd-442a-ba28-9b1e5d5d1e96/campaign_trackers/b164f1b0-f665-433d-af92-481367edf410/influencers?provider=youtube&sort_term=imp_desc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: kourtney@kohler.name" \
-H "Authorization: B67sWxa3x2sEAJ61YBux" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/influencers
GET /api/v1/campaigns/73d44a12-e6fd-442a-ba28-9b1e5d5d1e96/campaign_trackers/b164f1b0-f665-433d-af92-481367edf410/influencers?provider=youtube&sort_term=imp_desc
Accept: application/json
Content-Type: application/json
Parameters
provider: youtube
sort_term: imp_desc
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| provider required | Provider in lowercase |
| sort_term | influencers by engagements,impressions or reach |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "c4c7cd86-d448-4ed5-8e55-35afb7bc082c",
"type": "campaign_influencer",
"attributes": {
"provider": "youtube",
"username": "UcGQ00Rvc",
"name": "Odinma Umah",
"profile_image_url": "http://pbgyu.com/profile_img",
"description": "",
"location": null,
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199,
"impressions": 4500.0,
"reach": 4500.0,
"posts": {
"data": [
{
"id": "5e255c42-dd0c-420e-9754-ac89b90f0d80",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "c4c7cd86-d448-4ed5-8e55-35afb7bc082c",
"post_id": "vYilNc",
"formatted_created_date": "Jun 7, 2021 08:56 AM",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"created_date": "2021-06-07T07:56:36.577Z",
"post_url": "https://www.youtube.com/embed/vYilNc",
"post_type": "video",
"sentiment": "neutral",
"likes_count": 10100,
"views_count": 677099,
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"engagement": 695199,
"provider": "youtube",
"influencer": {
"provider": "youtube",
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"description": "",
"profile_image_url": "http://pbgyu.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199
}
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Campaign Trackers - Posts
Twitter Flow - Successful with start and end dates
Request
curl -g "http://localhost:3000/api/v1/campaigns/2eeca060-a1c5-45a2-8d75-755892ea6efb/campaign_trackers/008e62a4-82ca-42e9-97e3-6dd22342d19b/posts?start_date=2021-06-07&end_date=2021-06-14&provider=twitter&sort_by=asc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: christian@mccullough.biz" \
-H "Authorization: AQnCJy1emU_z4BmX2jfj" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/posts
GET /api/v1/campaigns/2eeca060-a1c5-45a2-8d75-755892ea6efb/campaign_trackers/008e62a4-82ca-42e9-97e3-6dd22342d19b/posts?start_date=2021-06-07&end_date=2021-06-14&provider=twitter&sort_by=asc
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
provider: twitter
sort_by: asc
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| provider required | Provider in lowercase |
| sort_by | Posts Engagement sort by most or least |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "510ca2c7-06ee-4065-9eb3-db9535210aba",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "e7cacf67-35ae-4fd8-9ff8-37f751b0b6ae",
"post_id": "244111636544225280",
"formatted_created_date": "Jun 8, 2021 08:56 AM",
"post_text": "full text",
"created_date": "2021-06-08T07:56:37.352Z",
"post_url": "http:twitter.com/ki",
"post_type": "quote",
"sentiment": "neutral",
"likes_count": 909,
"views_count": null,
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"engagement": 1035,
"provider": "twitter",
"influencer": {
"provider": "twitter",
"name": "Omenuko Ikemba",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"profile_image_url": "http://pbg.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 1035
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Instagram Flow - Successful with start and end dates
Request
curl -g "http://localhost:3000/api/v1/campaigns/5c23bcd1-e3e6-43ca-a1ed-885d9cdef246/campaign_trackers/19450530-c4b0-4340-90cb-4f2e5548ac01/posts?start_date=2020-08-01&end_date=2020-08-14&provider=instagram&sort_by=desc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: winfred.mclaughlin@franecki.org" \
-H "Authorization: XE3vS2go165eZ26cKauU" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/posts
GET /api/v1/campaigns/5c23bcd1-e3e6-43ca-a1ed-885d9cdef246/campaign_trackers/19450530-c4b0-4340-90cb-4f2e5548ac01/posts?start_date=2020-08-01&end_date=2020-08-14&provider=instagram&sort_by=desc
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2020-08-01
end_date: 2020-08-14
provider: instagram
sort_by: desc
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| provider required | Provider in lowercase |
| sort_by | Posts Engagement sort by most or least |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "1e28f740-e99c-47ad-bd12-dc7fd5ccfff0",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "2ba02efa-a798-4480-bdfd-be516965c68a",
"post_id": "17866774861955240",
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"created_date": "2020-08-11T07:04:26.000Z",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 65,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 69,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17866774861955240",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 69
}
}
},
{
"id": "eed8d90d-3d85-47ae-97ec-77707670f355",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "ff8a01f6-6cd2-415e-ad02-3b8c8ab8b540",
"post_id": "18029592184301103",
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"created_date": "2020-08-11T04:29:07.000Z",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 51,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 56,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18029592184301103",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 56
}
}
},
{
"id": "67399554-ab3e-4c69-8675-34a88624ecf2",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "3784aba7-6e75-4a13-a59f-c53c05351ca5",
"post_id": "18109911793157694",
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"post_text": "Sweet sour!",
"created_date": "2020-08-11T07:53:56.000Z",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"likes_count": 3,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 3,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18109911793157694",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 3
}
}
},
{
"id": "e7e799e7-482a-42b6-a237-16aeed94ae9b",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "084b7904-1832-4876-ae21-4697894e29af",
"post_id": "17898906232530244",
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"created_date": "2020-08-11T09:28:40.000Z",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"post_type": "IMAGE",
"sentiment": "neutral",
"likes_count": 1,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 2,
"provider": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17898906232530244",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 2
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Youtube Flow - Successful with start and end dates
Request
curl -g "http://localhost:3000/api/v1/campaigns/513ab882-efce-4c04-b24b-a1df8ea5df6a/campaign_trackers/50ba9f10-d6ce-46de-a3fd-43ba34e31661/posts?start_date=2021-06-07&end_date=2021-06-14&provider=youtube&sort_by=asc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lorena_mante@gutkowski.biz" \
-H "Authorization: GtTBFyjyk_xN_6D_5ny5" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/posts
GET /api/v1/campaigns/513ab882-efce-4c04-b24b-a1df8ea5df6a/campaign_trackers/50ba9f10-d6ce-46de-a3fd-43ba34e31661/posts?start_date=2021-06-07&end_date=2021-06-14&provider=youtube&sort_by=asc
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
provider: youtube
sort_by: asc
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| provider required | Provider in lowercase |
| sort_by | Posts Engagement sort by most or least |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "145de824-e436-41ba-95aa-04c5bcb33ed6",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "774a243c-488b-4fc0-a87c-f1cbc588c340",
"post_id": "vYilNc",
"formatted_created_date": "Jun 7, 2021 08:56 AM",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"created_date": "2021-06-07T07:56:38.272Z",
"post_url": "https://www.youtube.com/embed/vYilNc",
"post_type": "video",
"sentiment": "neutral",
"likes_count": 10100,
"views_count": 677099,
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"engagement": 695199,
"provider": "youtube",
"influencer": {
"provider": "youtube",
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"description": "",
"profile_image_url": "http://pbgyu.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Youtube Flow - Successful with filters
Request
curl -g "http://localhost:3000/api/v1/campaigns/2ad74cfb-b7f8-4754-a03d-305eabc6fea1/campaign_trackers/b2c0294b-5ea2-45a8-89e8-4c2d2b344026/posts?start_date=2021-06-07&end_date=2021-06-14&provider=youtube" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: verna.wisozk@blandazulauf.com" \
-H "Authorization: pYnUcfsG4erkyUR9KhA4" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/posts
GET /api/v1/campaigns/2ad74cfb-b7f8-4754-a03d-305eabc6fea1/campaign_trackers/b2c0294b-5ea2-45a8-89e8-4c2d2b344026/posts?start_date=2021-06-07&end_date=2021-06-14&provider=youtube
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
provider: youtube
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| provider required | Provider in lowercase |
| sort_by | Posts Engagement sort by most or least |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "f59b3216-960c-4170-a2db-fa743b6179c6",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "cae976a5-b414-4812-848c-e2bccdfee99f",
"post_id": "vYilNc",
"formatted_created_date": "Jun 7, 2021 08:56 AM",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"created_date": "2021-06-07T07:56:38.937Z",
"post_url": "https://www.youtube.com/embed/vYilNc",
"post_type": "video",
"sentiment": "neutral",
"likes_count": 10100,
"views_count": 677099,
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"engagement": 695199,
"provider": "youtube",
"influencer": {
"provider": "youtube",
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"description": "",
"profile_image_url": "http://pbgyu.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Youtube Flow - Successful with filters
Request
curl -g "http://localhost:3000/api/v1/campaigns/2f7578f9-e5c0-4bb1-af5a-dc5191d3fffd/campaign_trackers/eb899445-0590-4b67-a6fd-6d9283a049ff/posts?start_date=2021-06-07&end_date=2021-06-14&provider=youtube" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: barton@rolfsonwiegand.co" \
-H "Authorization: qL9a61TW6K-zLkb4db14" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/campaign_trackers/:campaign_tracker_id/posts
GET /api/v1/campaigns/2f7578f9-e5c0-4bb1-af5a-dc5191d3fffd/campaign_trackers/eb899445-0590-4b67-a6fd-6d9283a049ff/posts?start_date=2021-06-07&end_date=2021-06-14&provider=youtube
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
provider: youtube
| Name | Description |
|---|---|
| campaign_tracker_id required | Camapign Tracker ID |
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| provider required | Provider in lowercase |
| sort_by | Posts Engagement sort by most or least |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "3346223f-c8dc-470a-a234-d09bdd64d232",
"type": "campaign_post",
"attributes": {
"campaign_influencer_id": "6e0735f7-b7ec-4804-a074-e42339ed9d84",
"post_id": "vYilNc",
"formatted_created_date": "Jun 7, 2021 08:56 AM",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"created_date": "2021-06-07T07:56:39.462Z",
"post_url": "https://www.youtube.com/embed/vYilNc",
"post_type": "video",
"sentiment": "neutral",
"likes_count": 10100,
"views_count": 677099,
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"engagement": 695199,
"provider": "youtube",
"influencer": {
"provider": "youtube",
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"description": "",
"profile_image_url": "http://pbgyu.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Deliverables - Create New Records
Successful with for Creators and Publishers
Request
curl "http://localhost:3000/api/v1/professionals/20973626-5393-49ea-b7c9-1e4115d25366/deliverables" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[job_id]"
3ccf0142-2957-44aa-94ed-6c1564526f9e
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[links][]"
google.com/your-paper
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: almeda.feeney@luettgenpagac.name" \
-H "Authorization: fq7FDR2prLDqi1sTHYjf" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables
POST /api/v1/professionals/20973626-5393-49ea-b7c9-1e4115d25366/deliverables
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[job_id]"
3ccf0142-2957-44aa-94ed-6c1564526f9e
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[links][]"
google.com/your-paper
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| deliverable[links] | Publisher/Creators - Links to deliverables |
| deliverable[keywords] | Hashtags or Keywords |
| deliverable[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| deliverable[job_id] | Job ID for proposal |
| deliverable[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "5c4d0b3b-b913-454e-af60-00bfc5b2fc55",
"type": "deliverable",
"attributes": {
"links": [
"google.com/your-paper"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1WWpjNFlqRm1NaTFqWkdRMkxUUTRPV1l0T1RSaU5pMWhNamcwTWpsbFpUZ3hNekFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--4bf3d0630074e80b4b18784478b312ea34a88315/doc.pdf"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "55a5c7bd-9a0e-41aa-b12e-682b9a13673c",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "20973626-5393-49ea-b7c9-1e4115d25366",
"fullname": "Wallace Kuvalis",
"username": "wallace-kuvalis-165651b4-d8f3-4747-8a47-0917da09c1c9",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "9ec761af-9df6-4547-ae87-a44ad4adf937"
},
"job": {
"id": "3ccf0142-2957-44aa-94ed-6c1564526f9e",
"title": "Logo designs",
"description": "Sed nisi quia. Vitae saepe ut. Sint a odit.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Swaniawski-Murphy",
"business_id": "d5c56007-d2fb-466a-8ebc-068721d1bf85",
"business_name": "Wisoky-Walsh",
"business_avg_ratings": 0.0,
"business_wallet_id": "49dc1587-03b3-466a-86fb-3d02d5a3b583",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
}
Successful with for Influencers
Request
curl "http://localhost:3000/api/v1/professionals/f4b1fd41-4c0b-4303-bcd7-22d7b57927ec/deliverables" -d '{"deliverable":{"job_id":"050d40d5-c8c8-4c90-84c5-c997f9a966e9","links":["google.com/your-paper"],"posts":[{"id":"74283983749","post_url":"http://twurl.com/tytu","provider":"twitter"}]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: anitra@hahn.com" \
-H "Authorization: 7WSZW_RMyBGRe4QZ_jT8" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables
POST /api/v1/professionals/f4b1fd41-4c0b-4303-bcd7-22d7b57927ec/deliverables
Accept: application/json
Content-Type: application/json
Parameters
{"deliverable":{"job_id":"050d40d5-c8c8-4c90-84c5-c997f9a966e9","links":["google.com/your-paper"],"posts":[{"id":"74283983749","post_url":"http://twurl.com/tytu","provider":"twitter"}]}}
| Name | Description |
|---|---|
| deliverable[links] | Publisher/Creators - Links to deliverables |
| deliverable[keywords] | Hashtags or Keywords |
| deliverable[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| deliverable[job_id] | Job ID for proposal |
| deliverable[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "c4bb86cc-11c1-4d66-a509-e1eb8078dc5b",
"type": "deliverable",
"attributes": {
"links": [
"google.com/your-paper"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
],
"date_submitted": "2021-06-09",
"proposal_id": "a55e2a3d-ecc4-40fd-a94f-850187bb48e2",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "f4b1fd41-4c0b-4303-bcd7-22d7b57927ec",
"fullname": "Dinorah Purdy",
"username": "dinorah-purdy-a784a519-c366-452c-8d9d-ef169ca1a20f",
"professional_type": "influencer",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "16defbff-1c4b-4649-b606-836878a9c261"
},
"job": {
"id": "050d40d5-c8c8-4c90-84c5-c997f9a966e9",
"title": "Logo designs",
"description": "Dolores ut rem. Beatae occaecati dolorem. Suscipit sit sed.",
"job_type": "influencer",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Reichert Inc",
"business_id": "8006d812-4ea9-418c-8bcf-bc59f24d0e48",
"business_name": "Mitchell-Renner",
"business_avg_ratings": 0.0,
"business_wallet_id": "8378a882-cba0-492e-97bb-0333c138c72d",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
}
Without links and documents comments
Request
curl "http://localhost:3000/api/v1/professionals/d7d4558e-c225-459f-93de-f17155d0facf/deliverables" -d '{"deliverable":{"job_id":"5d730dcf-3215-4de6-806e-0c306473a93a","links":[]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: amiee@hodkiewicz.com" \
-H "Authorization: 4bttJt66of-nE_KsHABp" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables
POST /api/v1/professionals/d7d4558e-c225-459f-93de-f17155d0facf/deliverables
Accept: application/json
Content-Type: application/json
Parameters
{"deliverable":{"job_id":"5d730dcf-3215-4de6-806e-0c306473a93a","links":[]}}
| Name | Description |
|---|---|
| deliverable[links] | Publisher/Creators - Links to deliverables |
| deliverable[keywords] | Hashtags or Keywords |
| deliverable[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| deliverable[job_id] | Job ID for proposal |
| deliverable[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "deliverable",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base Please add posts, links or documents before submitting",
"title": "Please add posts, links or documents before submitting"
}
]
}
Business user should not create deliverables
Request
curl "http://localhost:3000/api/v1/professionals/c0af66f9-e2d4-4f73-bdca-a8b25661f925/deliverables" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[job_id]"
efc14d2b-2a70-4d1a-9b8f-4983cde508d4
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[links][]"
google.com/your-paper
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: olimpia.skiles@tillman.io" \
-H "Authorization: QWUMBbJ4KffitxUCLW4Z" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables
POST /api/v1/professionals/c0af66f9-e2d4-4f73-bdca-a8b25661f925/deliverables
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[job_id]"
efc14d2b-2a70-4d1a-9b8f-4983cde508d4
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[links][]"
google.com/your-paper
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| deliverable[links] | Publisher/Creators - Links to deliverables |
| deliverable[keywords] | Hashtags or Keywords |
| deliverable[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| deliverable[job_id] | Job ID for proposal |
| deliverable[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/professionals/8bda2fc2-fcbb-4bf9-885e-d02e0f1aa2f7/deliverables" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[job_id]"
5063adb7-c637-4a15-9e76-c390ae724a13
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[links][]"
google.com/your-paper
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables
POST /api/v1/professionals/8bda2fc2-fcbb-4bf9-885e-d02e0f1aa2f7/deliverables
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[job_id]"
5063adb7-c637-4a15-9e76-c390ae724a13
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[links][]"
google.com/your-paper
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="deliverable[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| deliverable[links] | Publisher/Creators - Links to deliverables |
| deliverable[keywords] | Hashtags or Keywords |
| deliverable[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| deliverable[job_id] | Job ID for proposal |
| deliverable[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Deliverables - Get All
Getting all deliverable
Request
curl -g "http://localhost:3000/api/v1/professionals/e7478634-738f-4a2e-8bea-fb0f29cc403e/deliverables" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: leroy.boyer@marquardtkohler.io" \
-H "Authorization: Zfz4vDeFNd1YNQuLXCK7" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/deliverables
GET /api/v1/professionals/e7478634-738f-4a2e-8bea-fb0f29cc403e/deliverables
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "116b9e65-cea6-4368-b6d0-43124587cdb8",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxoTXpFelpqSm1ZeTFsWkRnM0xUUmhOell0T0RRNE9DMHhZVGN3WW1VNE1tWTBNMlVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--cf167b0dde18e63367feaba3cc0b3ef6fc1cae77/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": null,
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "e7478634-738f-4a2e-8bea-fb0f29cc403e",
"fullname": "Voncile Wisoky",
"username": "voncile-wisoky-9ece018f-73cb-4859-afb0-ada84f3294a8",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "1da9405e-e9a6-4a4f-8c01-bf0566146098"
},
"job": {
"id": "9293d037-cf3c-4448-a8ea-6636e01ab62a",
"title": "Logo designs",
"description": "Et non voluptas. Facilis at praesentium. Veniam nihil qui.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Zemlak Group",
"business_id": "53700065-480f-41cb-b756-7d19ff0dafde",
"business_name": "Bins, Upton and Harvey",
"business_avg_ratings": 0.0,
"business_wallet_id": "3043c013-ee57-407c-bc33-062d0e2e63ec",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
]
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/professionals/c949a2fc-5d38-416b-9281-b369bdac0df4/deliverables" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/deliverables
GET /api/v1/professionals/c949a2fc-5d38-416b-9281-b369bdac0df4/deliverables
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Deliverables - Get One
Getting a professional's deliverable for a job
Request
curl -g "http://localhost:3000/api/v1/professionals/da998675-4a03-4258-a257-c0889560d1ee/deliverables/13f46075-57e8-42f6-95f8-d91e0c233d59" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: marty@armstronghane.net" \
-H "Authorization: u7LA3X4xeP6Aq8vNzFNn" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/deliverables/:id
GET /api/v1/professionals/da998675-4a03-4258-a257-c0889560d1ee/deliverables/13f46075-57e8-42f6-95f8-d91e0c233d59
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "13f46075-57e8-42f6-95f8-d91e0c233d59",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "approved",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxrWkRsaU5XSm1ZUzAwT1RobExUUTNZbUl0WWpjM05TMHpOR001TldJd05XVmlabUVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--03ff74c44dea7b205e909727424100c5b66a0ab4/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "50097d9d-c1d3-4191-8204-36cbe6cd142a",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": "2 days"
},
"professional": {
"id": "da998675-4a03-4258-a257-c0889560d1ee",
"fullname": "Bonny Ryan",
"username": "bonny-ryan-cff1dc71-fff6-43b9-bd25-eeecb60c95e0",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 3.0,
"wallet_id": "4d481f49-e307-42e0-acca-245a1b7f1964"
},
"job": {
"id": "f8c4a2f5-e32b-4256-bd84-5c52b17e3d22",
"title": "Logo designs",
"description": "Non quos repellat. Non aut omnis. Voluptatum velit quia.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Heathcote-Hilpert",
"business_id": "8caa14aa-9252-4568-8cc2-cc825d5e9112",
"business_name": "Roob, Feest and Moore",
"business_avg_ratings": 3.0,
"business_wallet_id": "cc7a24d9-1333-4fe1-a6e1-e71b34645ca5",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
{
"summary": "Et neque recusandae. Repellat cum aut. Laborum occaecati quo.",
"ratings": 3,
"created_at_in_words": "less than a minute"
}
],
"business_reviews": [
{
"summary": "Et ut itaque. Dolore enim rerum. Nesciunt sed eum.",
"ratings": 3,
"created_at_in_words": "less than a minute",
"reviewer_name": "Bonny Ryan",
"username": "bonny-ryan-cff1dc71-fff6-43b9-bd25-eeecb60c95e0",
"profile_image_url": ""
}
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/professionals/dcd8667f-abe3-4d94-8cff-21a6034eb734/deliverables/b707d865-ba20-495b-b45e-16ac68590176" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/deliverables/:id
GET /api/v1/professionals/dcd8667f-abe3-4d94-8cff-21a6034eb734/deliverables/b707d865-ba20-495b-b45e-16ac68590176
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/professionals/d5c7575c-b1f7-4e22-a4d9-9f8c3f1bd80e/deliverables/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: crystal@streich.name" \
-H "Authorization: 4hwn7WkP8pcv9VKZ_BDa" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/deliverables/:id
GET /api/v1/professionals/d5c7575c-b1f7-4e22-a4d9-9f8c3f1bd80e/deliverables/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
When job id is not availabe
Request
curl -g "http://localhost:3000/api/v1/professionals/8a56c9eb-7194-42b4-bd34-85a479be5cbe/deliverables/%3Aid" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: elden.spencer@smith.net" \
-H "Authorization: 8NRFjFUbXFGE5-T7ivK7" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/deliverables/:id
GET /api/v1/professionals/8a56c9eb-7194-42b4-bd34-85a479be5cbe/deliverables/%3Aid
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Deliverables - Update
Successful with with valid params
Request
curl "http://localhost:3000/api/v1/professionals/71dcd54d-c4ef-4ab1-996a-5e454d37f26c/deliverables/746b4dc0-dbff-4a7e-8bc4-76cbd6a15143" -d '{"deliverable":{"links":["google.com/your-paper-for-feedback"],"documents":[{"original_filename":"fruits.jpeg","tempfile":"#\u003cFile:0x00007fb75dc66148\u003e","content_type":null}]}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: garrett@lueilwitzhegmann.org" \
-H "Authorization: HYBv8SizSbPusBgyj6H_" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:professional_id/deliverables/:id
PATCH /api/v1/professionals/71dcd54d-c4ef-4ab1-996a-5e454d37f26c/deliverables/746b4dc0-dbff-4a7e-8bc4-76cbd6a15143
Accept: application/json
Content-Type: application/json
Parameters
{"deliverable":{"links":["google.com/your-paper-for-feedback"],"documents":[{"original_filename":"fruits.jpeg","tempfile":"#\u003cFile:0x00007fb75dc66148\u003e","content_type":null}]}}
| Name | Description |
|---|---|
| deliverable[links] | Publisher/Creators - Links to deliverables |
| deliverable[keywords] | Hashtags or Keywords |
| deliverable[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| deliverable[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "746b4dc0-dbff-4a7e-8bc4-76cbd6a15143",
"type": "deliverable",
"attributes": {
"links": [
"google.com/your-paper-for-feedback"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsxTjJNd05tUXdNUzFoTWpVNExUUmxaak10T1RJMFlpMDNPR1F5T0Raa1pEQmtNV1FHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--22b1392a05cc6692bf10aded84ca30473d280b7c/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "a535c2e8-6e59-44b0-ae6c-c24e6b3ec126",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "71dcd54d-c4ef-4ab1-996a-5e454d37f26c",
"fullname": "Melania Kshlerin",
"username": "melania-kshlerin-9556ba0a-df5e-4a04-a1d8-7a1dbe06a6bd",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "f0f14de2-59ae-4b6e-a497-2386b394ed29"
},
"job": {
"id": "b3864b76-0309-410e-9d1a-702d4f3da3a4",
"title": "Logo designs",
"description": "Culpa quo sequi. Facilis quis at. Et deleniti saepe.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "McDermott-Johns",
"business_id": "82d18a8c-12c7-42f5-a0ee-2690f50702d7",
"business_name": "Hane LLC",
"business_avg_ratings": 0.0,
"business_wallet_id": "3d0c54fb-6a6e-448a-b08c-319b3b168860",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
}
Without links and documents comments
Request
curl "http://localhost:3000/api/v1/professionals/17d393ac-152d-4f71-80fb-f133cebf7bfe/deliverables/5636fd2e-5dc7-4f78-8639-7a1be181d833" -d '{"deliverable":{"links":[]}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tobie.watsica@pacocha.io" \
-H "Authorization: 3XxNg5T4JMHx3dtHBLUV" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:professional_id/deliverables/:id
PATCH /api/v1/professionals/17d393ac-152d-4f71-80fb-f133cebf7bfe/deliverables/5636fd2e-5dc7-4f78-8639-7a1be181d833
Accept: application/json
Content-Type: application/json
Parameters
{"deliverable":{"links":[]}}
| Name | Description |
|---|---|
| deliverable[links] | Publisher/Creators - Links to deliverables |
| deliverable[keywords] | Hashtags or Keywords |
| deliverable[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| deliverable[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "5636fd2e-5dc7-4f78-8639-7a1be181d833",
"type": "deliverable",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base Please add posts, links or documents before submitting",
"title": "Please add posts, links or documents before submitting"
}
]
}
Deliverables - Respond
Successful with valid params
Request
curl "http://localhost:3000/api/v1/professionals/d6f90113-2299-460b-9794-69a5f83b3a2a/deliverables/214a9216-da1b-4501-8bc1-92566ce403ca/respond" -d '{"comment":{"description":"Architecto deleniti iste. Doloribus dicta saepe. Dicta quaerat non."}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: abram@blick.io" \
-H "Authorization: BuuANx61iuWWxtnq8kyy" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables/:deliverable_id/respond
POST /api/v1/professionals/d6f90113-2299-460b-9794-69a5f83b3a2a/deliverables/214a9216-da1b-4501-8bc1-92566ce403ca/respond
Accept: application/json
Content-Type: application/json
Parameters
{"comment":{"description":"Architecto deleniti iste. Doloribus dicta saepe. Dicta quaerat non."}}
| Name | Description |
|---|---|
| comment[description] | Text with questions to ask business |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "214a9216-da1b-4501-8bc1-92566ce403ca",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "clarification_requested",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsyWW1ZNVlXRTFNQzAzT1daaUxUUXlaVE10T1RGaFpTMWlaVFJoTkRObU1tVmlaalVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--cecf3252a4322617ab2342ba73249da15c4d3b7d/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "70bced3d-8fe9-40f0-a301-e507be59a260",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "d6f90113-2299-460b-9794-69a5f83b3a2a",
"fullname": "Jamila Jacobi",
"username": "jamila-jacobi-fcecbd18-18d2-4553-92ce-9d1e1821be33",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "44028d7b-0e7a-4d7b-96b7-0b0cd7506e13"
},
"job": {
"id": "5b20658c-8d74-47fd-95df-45ee7c8deb1d",
"title": "Logo designs",
"description": "Modi unde aspernatur. Autem accusamus quia. Vel omnis quaerat.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Fay, Mosciski and Larkin",
"business_id": "c0d865ee-1f35-4d6b-b223-2e03a5a3d831",
"business_name": "Thiel, Bode and Kerluke",
"business_avg_ratings": 0.0,
"business_wallet_id": "1889bdea-8843-4345-a83b-e1f3876bd480",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
{
"id": "13545a2b-b18b-4b66-9d76-250100f08a38",
"type": "deliverable_comment",
"attributes": {
"fullname": "Jamila Jacobi",
"created_by": "Professional",
"description": "Architecto deleniti iste. Doloribus dicta saepe. Dicta quaerat non.",
"created_at_in_words": "less than a minute"
}
}
]
}
}
}
}
Without required description
Request
curl "http://localhost:3000/api/v1/professionals/9667f4e6-9f25-4adb-91bd-d40b9c364735/deliverables/66594f33-bf92-4f71-bec0-13b560eb0cc7/respond" -d '{"comment":{"description":""}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: bao@olsonleffler.com" \
-H "Authorization: NwMsidMhVwNg4nA9_Vsx" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables/:deliverable_id/respond
POST /api/v1/professionals/9667f4e6-9f25-4adb-91bd-d40b9c364735/deliverables/66594f33-bf92-4f71-bec0-13b560eb0cc7/respond
Accept: application/json
Content-Type: application/json
Parameters
{"comment":{"description":""}}
| Name | Description |
|---|---|
| comment[description] | Text with questions to ask business |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "deliverablecomment",
"errors": [
{
"source": {
"pointer": "/data/attributes/description"
},
"detail": "Description can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/professionals/f9f7424b-57d9-45e1-b2ba-e5579c901cee/deliverables/a8baaebe-4960-43a4-ae9b-ab00e44df477/respond" -d '{"comment":{"description":"Sunt hic ut. Libero cum quam. Quod id dolores."}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables/:deliverable_id/respond
POST /api/v1/professionals/f9f7424b-57d9-45e1-b2ba-e5579c901cee/deliverables/a8baaebe-4960-43a4-ae9b-ab00e44df477/respond
Accept: application/json
Content-Type: application/json
Parameters
{"comment":{"description":"Sunt hic ut. Libero cum quam. Quod id dolores."}}
| Name | Description |
|---|---|
| comment[description] | Text with questions to ask business |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Deliverables - Submit Changes
Successful with valid params
Request
curl "http://localhost:3000/api/v1/professionals/d79a6b27-9429-4ad1-a384-224c1c75da72/deliverables/c6b8f77f-ec7c-4e4c-862f-452a1fb20379/submit_changes" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="iteration[links][]"
twurl/yu78hjn8
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="iteration[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: haie_glover@waelchi.biz" \
-H "Authorization: HrGaSCWNnFGGe_rWMHUg" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables/:deliverable_id/submit_changes
POST /api/v1/professionals/d79a6b27-9429-4ad1-a384-224c1c75da72/deliverables/c6b8f77f-ec7c-4e4c-862f-452a1fb20379/submit_changes
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="iteration[links][]"
twurl/yu78hjn8
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="iteration[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| iteration[links] | Publisher/Creators - Links to deliverables |
| iteration[keywords] | Hashtags or Keywords |
| iteration[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| iteration[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "c6b8f77f-ec7c-4e4c-862f-452a1fb20379",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "feedback_sent",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtTkRkbU1XTXhPUzAzTmpjMUxUUmhPVFF0T0RKbFlpMDNabUptTkdGa00ySTFOREFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--74194193944e098713afd35b3c8d057b6efa372b/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": "93299ce9-d879-41d0-a9e6-b0423c59bbf8",
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "d79a6b27-9429-4ad1-a384-224c1c75da72",
"fullname": "Chelsie Hodkiewicz",
"username": "chelsie-hodkiewicz-285f146e-14a9-4564-9984-3fabc400939b",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "170a1545-8018-49bb-85e3-0a01685851f1"
},
"job": {
"id": "9b813310-0f7f-4f9f-9ea7-4db3199e61a4",
"title": "Logo designs",
"description": "Provident labore illum. Eum eveniet saepe. Tenetur illum officia.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "O'Kon, Bradtke and Gorczany",
"business_id": "e63a1c01-e869-48e8-bce7-66be66937af7",
"business_name": "Schroeder, Hirthe and Bahringer",
"business_avg_ratings": 0.0,
"business_wallet_id": "8ecd739a-ffaa-4311-aab2-a001b1f6d2a7",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
{
"id": "76897f3d-c118-417a-b06e-7916000faf5a",
"type": "iteration",
"attributes": {
"fullname": "Chelsie Hodkiewicz",
"links": [
"twurl/yu78hjn8"
],
"keywords": [
],
"posts": [
],
"created_at": "2021-06-09T07:56:47.815Z",
"documents": [
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt3Tm1VME56TmpPQzAzWm1FeUxUUXhNakV0WVRObFlTMDJZekV4T1dZeU5UVXdORFFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--07485173c2b49e24a340b8ca6c1fab2724a96fdf/doc.pdf"
}
],
"created_at_in_words": "less than a minute"
}
}
]
},
"comments": {
"data": [
]
}
}
}
}
Without required links or documents
Request
curl "http://localhost:3000/api/v1/professionals/3b1bd979-1e30-401e-8377-e0d03d838b0a/deliverables/87a4c6f3-d671-46ab-b719-3ae559b66fad/submit_changes" -d '{"iteration":{"links":[]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: maude.schuppe@harveyrunolfsdottir.io" \
-H "Authorization: xRqcWc6mD_AjDP6fbYU3" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables/:deliverable_id/submit_changes
POST /api/v1/professionals/3b1bd979-1e30-401e-8377-e0d03d838b0a/deliverables/87a4c6f3-d671-46ab-b719-3ae559b66fad/submit_changes
Accept: application/json
Content-Type: application/json
Parameters
{"iteration":{"links":[]}}
| Name | Description |
|---|---|
| iteration[links] | Publisher/Creators - Links to deliverables |
| iteration[keywords] | Hashtags or Keywords |
| iteration[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| iteration[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "iteration",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base Please add posts, links or documents before submitting",
"title": "Please add posts, links or documents before submitting"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/professionals/def4653a-0a8f-4940-8614-385e00e99edd/deliverables/34914e1d-62bd-4431-944f-b3a2e63965fb/submit_changes" -d '{"iteration":{"links":["twurl/yu78hjn8"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/deliverables/:deliverable_id/submit_changes
POST /api/v1/professionals/def4653a-0a8f-4940-8614-385e00e99edd/deliverables/34914e1d-62bd-4431-944f-b3a2e63965fb/submit_changes
Accept: application/json
Content-Type: application/json
Parameters
{"iteration":{"links":["twurl/yu78hjn8"]}}
| Name | Description |
|---|---|
| iteration[links] | Publisher/Creators - Links to deliverables |
| iteration[keywords] | Hashtags or Keywords |
| iteration[documents] | Publisher/Creators - Documents(PDF, Images, Video files) |
| iteration[posts] | Influencer only - Posts from their social account |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Deliverables - Delete
Successfully deletes a job
Request
curl "http://localhost:3000/api/v1/professionals/aca24848-da5a-4d8e-847d-5cbbbcd1124d/deliverables/592b3302-9ba1-4464-96ac-f50e5053cff9" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: xavier.quitzon@blick.name" \
-H "Authorization: kQ5jbzk7ZsYcrCwP4ueA" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/deliverables/:id
DELETE /api/v1/professionals/aca24848-da5a-4d8e-847d-5cbbbcd1124d/deliverables/592b3302-9ba1-4464-96ac-f50e5053cff9
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "54b34d19-7e24-4f1e-8b91-3bc7f57a83d4",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
],
"date_submitted": "2021-06-09",
"proposal_id": null,
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "aca24848-da5a-4d8e-847d-5cbbbcd1124d",
"fullname": "Willy Upton",
"username": "willy-upton-512b90a7-564d-4e41-a98e-d45dff475f7c",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "53760ffb-eebb-4713-a7e4-d9742ff0dba5"
},
"job": {
"id": "3350bba2-f1df-41cc-888a-99d82cf5552e",
"title": "Logo designs",
"description": "Aliquam neque maiores. Officia exercitationem quia. Quaerat eveniet minus.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Mayer Inc",
"business_id": "1deead97-3da2-4d59-9cc6-1910bf5eec1f",
"business_name": "Donnelly Group",
"business_avg_ratings": 0.0,
"business_wallet_id": "2827fbc4-ea5e-4419-af9f-8f237807f879",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
},
{
"id": "dc626920-1c1a-4562-ba9b-813aebdbe042",
"type": "deliverable",
"attributes": {
"links": [
"www.newsroom.com/post-about-your-brand"
],
"keywords": [
],
"posts": [
],
"approved_by": null,
"status": "submitted",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWszT1RoaU1XTmxaQzAxTVdKaUxUUmtOakV0T1RnMFlpMDJNRGt6WkROa05UazRNak1HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--3dd679b3ab5108b1ddf24f28b448069b3ac9b11c/fruits.jpeg"
}
],
"date_submitted": "2021-06-09",
"proposal_id": null,
"formatted_dates": {
"date_submitted_in_words": "less than a minute",
"approved_at_in_words": null
},
"professional": {
"id": "aca24848-da5a-4d8e-847d-5cbbbcd1124d",
"fullname": "Willy Upton",
"username": "willy-upton-512b90a7-564d-4e41-a98e-d45dff475f7c",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "53760ffb-eebb-4713-a7e4-d9742ff0dba5"
},
"job": {
"id": "dbda013c-561b-4958-88ea-68baf3c437b0",
"title": "Logo designs",
"description": "Illo quasi sint. Sed aliquam necessitatibus. Commodi illo corporis.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"application_deadline": "2021-06-14",
"campaign_name": "Mayer Inc",
"business_id": "1deead97-3da2-4d59-9cc6-1910bf5eec1f",
"business_name": "Donnelly Group",
"business_avg_ratings": 0.0,
"business_wallet_id": "2827fbc4-ea5e-4419-af9f-8f237807f879",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"professional_reviews": [
],
"business_reviews": [
],
"iterations": {
"data": [
]
},
"comments": {
"data": [
]
}
}
}
]
}
Business user deleting a deliverable
Request
curl "http://localhost:3000/api/v1/professionals/d592cc37-5678-4e0e-a1de-1e375b5038a6/deliverables/9db0c815-3b44-45ff-9d40-a25a975e6bf6" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: danuta_wyman@farrell.org" \
-H "Authorization: s66xaxrdwbc3Kar9-EM7" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/deliverables/:id
DELETE /api/v1/professionals/d592cc37-5678-4e0e-a1de-1e375b5038a6/deliverables/9db0c815-3b44-45ff-9d40-a25a975e6bf6
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Without Authentication
Request
curl "http://localhost:3000/api/v1/professionals/1d647240-3e91-4aa6-ab81-a01f80c23b0f/deliverables/48835397-7a5a-48e7-9378-0713770e9b9e" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/deliverables/:id
DELETE /api/v1/professionals/1d647240-3e91-4aa6-ab81-a01f80c23b0f/deliverables/48835397-7a5a-48e7-9378-0713770e9b9e
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Jobs - Create New Records
Successful with valid params
Request
curl "http://localhost:3000/api/v1/campaigns/e2b24d28-a54b-4eb9-8f54-08e6dcf0d7ea/jobs" -d '{"job":{"title":"Newspaper Advert","description":"Ea aut deserunt. Omnis et excepturi. At corporis voluptatem.","job_type":"publisher","skills":["Writing","Copy writing"],"start_date":"2021-06-10","end_date":"2021-06-13","budget":20000,"professionals_count":2}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: terese.mueller@creminschroeder.info" \
-H "Authorization: nK9xSTpB88qEs-Fx7ksp" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/jobs
POST /api/v1/campaigns/e2b24d28-a54b-4eb9-8f54-08e6dcf0d7ea/jobs
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"title":"Newspaper Advert","description":"Ea aut deserunt. Omnis et excepturi. At corporis voluptatem.","job_type":"publisher","skills":["Writing","Copy writing"],"start_date":"2021-06-10","end_date":"2021-06-13","budget":20000,"professionals_count":2}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals needed |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "27a54937-545d-46dc-b37c-bf8e19ad9615",
"type": "job",
"attributes": {
"campaign_name": "Littel, Emard and Hammes",
"campaign_id": "e2b24d28-a54b-4eb9-8f54-08e6dcf0d7ea",
"title": "Newspaper Advert",
"description": "Ea aut deserunt. Omnis et excepturi. At corporis voluptatem.",
"job_type": "publisher",
"skills": [
"Writing",
"Copy writing"
],
"end_date": "2021-06-13",
"start_date": "2021-06-10",
"budget": {
"formated_dollar_value": "$20,000",
"formated_naira_value": "₦9,400,000",
"value": 20000
},
"status": "published",
"created_by": "fa2aa5b7-9172-4de0-a7ff-4b48e433f6ef",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": null,
"professionals_count": 2,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 10, 2021",
"end_date": "June 13, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": null
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "f53705b8-e2aa-4014-a973-dea2529c1f47",
"business_name": "Dickens, Hyatt and Shanahan",
"business_avg_ratings": 0.0,
"documents": [
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
}
Unsuccessful with incomplete params
Request
curl "http://localhost:3000/api/v1/campaigns/ef3a2f73-6510-48e6-87d4-78f57902d017/jobs" -d '{"job":{"title":"Newspaper Advert","description":"Cum qui sapiente. Deleniti nihil error. Unde beatae ullam.","job_type":"publisher","skills":["Writing","Copy writing"],"start_date":"2021-06-10"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: herbert_erdman@watsicahammes.biz" \
-H "Authorization: CMG-nh5PysYuNfiVYE6q" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/jobs
POST /api/v1/campaigns/ef3a2f73-6510-48e6-87d4-78f57902d017/jobs
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"title":"Newspaper Advert","description":"Cum qui sapiente. Deleniti nihil error. Unde beatae ullam.","job_type":"publisher","skills":["Writing","Copy writing"],"start_date":"2021-06-10"}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals needed |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "job",
"errors": [
{
"source": {
"pointer": "/data/attributes/end_date"
},
"detail": "End_date can't be blank",
"title": "can't be blank"
},
{
"source": {
"pointer": "/data/attributes/professionals_count"
},
"detail": "Professionals_count can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/campaigns/ca6c19b6-75e4-44f2-892f-0d74f1e39072/jobs" -d '{"job":{"title":"Youtube Advert","job_type":["creator"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/jobs
POST /api/v1/campaigns/ca6c19b6-75e4-44f2-892f-0d74f1e39072/jobs
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"title":"Youtube Advert","job_type":["creator"]}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals needed |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Jobs - Create New Records As Draft
Successful with incomplete params
Request
curl "http://localhost:3000/api/v1/campaigns/0e40e034-370d-41c8-8ec5-59b5310ee762/jobs/save_as_draft" -d '{"job":{"title":"Newspaper Advert","description":"Unde velit autem. Eum ut similique. Quasi odio consequuntur.","job_type":"publisher","skills":["Writing","Copy writing"],"start_date":"2021-06-10","end_date":"2021-06-13","professionals_count":2}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: terisa.lueilwitz@hodkiewicz.info" \
-H "Authorization: FZDY2gDdpuYx9iDVJSyy" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/jobs/save_as_draft
POST /api/v1/campaigns/0e40e034-370d-41c8-8ec5-59b5310ee762/jobs/save_as_draft
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"title":"Newspaper Advert","description":"Unde velit autem. Eum ut similique. Quasi odio consequuntur.","job_type":"publisher","skills":["Writing","Copy writing"],"start_date":"2021-06-10","end_date":"2021-06-13","professionals_count":2}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals needed |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "37db93ec-9ea8-46cc-8c18-d77240247fa3",
"type": "job",
"attributes": {
"campaign_name": "Corkery-Mills",
"campaign_id": "0e40e034-370d-41c8-8ec5-59b5310ee762",
"title": "Newspaper Advert",
"description": "Unde velit autem. Eum ut similique. Quasi odio consequuntur.",
"job_type": "publisher",
"skills": [
"Writing",
"Copy writing"
],
"end_date": "2021-06-13",
"start_date": "2021-06-10",
"budget": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"status": "draft",
"created_by": "50aa147a-5f37-41c4-b42f-c4e62ac9aa6e",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": null,
"professionals_count": 2,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 10, 2021",
"end_date": "June 13, 2021",
"published_at": null,
"started_at": null,
"application_deadline": null
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "26382b17-3171-41d5-b47e-33b78f7518ce",
"business_name": "Watsica, Stamm and Kling",
"business_avg_ratings": 0.0,
"documents": [
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
}
Fails when title is blank
Request
curl "http://localhost:3000/api/v1/campaigns/9782b996-2ffb-4b1c-95e1-ed7e1a89044a/jobs/save_as_draft" -d '{"job":{"title":"","description":"Quibusdam fugiat placeat. Ut earum et. Aliquid amet molestiae.","job_type":"creator"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: victor_dicki@macejkovic.net" \
-H "Authorization: fxswhpJtVxXLWspV-1dW" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/jobs/save_as_draft
POST /api/v1/campaigns/9782b996-2ffb-4b1c-95e1-ed7e1a89044a/jobs/save_as_draft
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"title":"","description":"Quibusdam fugiat placeat. Ut earum et. Aliquid amet molestiae.","job_type":"creator"}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals needed |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "job",
"errors": [
{
"source": {
"pointer": "/data/attributes/title"
},
"detail": "Title can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/campaigns/53a0f3b7-2cf2-4d62-82a7-5f09820317b8/jobs/save_as_draft" -d '{"job":{"title":"Youtube Advert","job_type":["creator"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/campaigns/:campaign_id/jobs/save_as_draft
POST /api/v1/campaigns/53a0f3b7-2cf2-4d62-82a7-5f09820317b8/jobs/save_as_draft
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"title":"Youtube Advert","job_type":["creator"]}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals needed |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Jobs - Get All
Getting a list of jobs
Request
curl -g "http://localhost:3000/api/v1/campaigns/3103f2e0-fcc5-441a-a525-09cfd915aaf5/jobs" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: fidela@hettinger.name" \
-H "Authorization: skBCnLBJ_Uu2DXNyceu1" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/jobs
GET /api/v1/campaigns/3103f2e0-fcc5-441a-a525-09cfd915aaf5/jobs
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "aace5eb8-98bd-40e3-be43-446c2f09fcdd",
"type": "job",
"attributes": {
"campaign_name": "Abbott-Breitenberg",
"campaign_id": "3103f2e0-fcc5-441a-a525-09cfd915aaf5",
"title": "Logo designs",
"description": "Pariatur omnis tempore. Voluptates et quam. Sunt incidunt est.",
"job_type": "publisher",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "6adbfab4-5c2d-4b98-89d0-e2e7c78f2f3a",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "7296e6f0-ef80-4d82-a192-bbd880da76a8",
"business_name": "Pacocha, Leffler and Wisozk",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxpTjJFNE56Rm1ZeTAyTUdZeUxUUXlOR1F0WWpjMk1DMWlOekJrT0dGaFpqTmhaR1lHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--77ce598d393ccaf2cc81b5b66dc6b0c7224a39cd/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "bc938542-1bbb-4e0e-9ed5-b94d77e55eff",
"type": "job",
"attributes": {
"campaign_name": "Abbott-Breitenberg",
"campaign_id": "3103f2e0-fcc5-441a-a525-09cfd915aaf5",
"title": "Logo designs",
"description": "Repudiandae rerum quo. Harum atque sit. Eos non autem.",
"job_type": "influencer",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "6adbfab4-5c2d-4b98-89d0-e2e7c78f2f3a",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "7296e6f0-ef80-4d82-a192-bbd880da76a8",
"business_name": "Pacocha, Leffler and Wisozk",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxsTm1FeE56RXhZUzFtTkdGbExUUXdNV1V0T1RjNVl5MHlORGRsWmpObU1tRTNaREVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--1d49aa9a9ddaa3613d4f435f18b046a3982d7ff1/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "946b456f-46d2-4034-86c5-31aa9a1fe2a7",
"type": "job",
"attributes": {
"campaign_name": "Abbott-Breitenberg",
"campaign_id": "3103f2e0-fcc5-441a-a525-09cfd915aaf5",
"title": "Logo designs",
"description": "Pariatur delectus nesciunt. Dolor officia voluptas. Quia totam magni.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "6adbfab4-5c2d-4b98-89d0-e2e7c78f2f3a",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "7296e6f0-ef80-4d82-a192-bbd880da76a8",
"business_name": "Pacocha, Leffler and Wisozk",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxrTURCaE1HVmhaUzB4WldZd0xUUXlOVGd0WVdOaE1DMWtNVEZqTVRaaE9ESmxNVGtHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--a8b6461fe7fe3740db610a190111d075b23174a9/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "cbd52cde-812c-468c-8b36-05aad2c7563d",
"type": "job",
"attributes": {
"campaign_name": "Abbott-Breitenberg",
"campaign_id": "3103f2e0-fcc5-441a-a525-09cfd915aaf5",
"title": "Logo designs",
"description": "Officia voluptatem reprehenderit. Consequuntur explicabo molestiae. Iste quod est.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "6adbfab4-5c2d-4b98-89d0-e2e7c78f2f3a",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "7296e6f0-ef80-4d82-a192-bbd880da76a8",
"business_name": "Pacocha, Leffler and Wisozk",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtTURObFlqazVaUzAzTkRJekxUUTFOalF0WVRRM09DMHlaR1U1WmpVM1lqSm1abVVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--8bcd33164510ccc1b285b8c3577cc1de3865acb1/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/2337ab72-2212-4e68-add4-c7148df8cb8a/jobs" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/jobs
GET /api/v1/campaigns/2337ab72-2212-4e68-add4-c7148df8cb8a/jobs
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Jobs - Get One
Getting a Campaign's job
Request
curl -g "http://localhost:3000/api/v1/campaigns/c364205c-e62a-4ab1-82c7-b732709bfbef/jobs/e95620f8-3fe9-442d-b695-b671e98f6007" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: dorthea@durgan.name" \
-H "Authorization: DQymtQwcBew6-WHCH_FA" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/jobs/:id
GET /api/v1/campaigns/c364205c-e62a-4ab1-82c7-b732709bfbef/jobs/e95620f8-3fe9-442d-b695-b671e98f6007
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "e95620f8-3fe9-442d-b695-b671e98f6007",
"type": "job",
"attributes": {
"campaign_name": "Howe LLC",
"campaign_id": "c364205c-e62a-4ab1-82c7-b732709bfbef",
"title": "Logo designs",
"description": "Nostrum dolorem voluptatibus. Quis ut ut. Natus quis quisquam.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "92efae79-ef9c-4613-b02b-f5778b8ed217",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "24e41d0c-2c64-4259-8799-c2e287baad63",
"business_name": "Dare and Sons",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxpT1dFMlpXTXhZeTAwTkRZekxUUmpaREV0T0dJd05DMDJabUUyTkRJNE56SXhaallHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--ce1e465490a5e58ca84d6c1c3c51e9ade7eadf78/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
}
Job with accepted proposal
Request
curl -g "http://localhost:3000/api/v1/campaigns/fd31711b-4b28-4b80-b5fd-68153afa757b/jobs/98f95c96-44da-4d6c-b146-082147d232f1" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: kathern_tillman@rosenbaumboyer.io" \
-H "Authorization: Dpgz2otWcNSCSzYhouM-" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/jobs/:id
GET /api/v1/campaigns/fd31711b-4b28-4b80-b5fd-68153afa757b/jobs/98f95c96-44da-4d6c-b146-082147d232f1
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "98f95c96-44da-4d6c-b146-082147d232f1",
"type": "job",
"attributes": {
"campaign_name": "Krajcik Group",
"campaign_id": "fd31711b-4b28-4b80-b5fd-68153afa757b",
"title": "Logo designs",
"description": "Ut iure aut. Ut deleniti consequatur. Recusandae delectus qui.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "started",
"created_by": "3b0506ad-2979-461d-b756-decc02e5eb38",
"published_by": null,
"started_by": "3b0506ad-2979-461d-b756-decc02e5eb38",
"completed_at": null,
"completed_by": null,
"assigned": [
{
"assigned_at": "2021-06-09T08:56:54.436+01:00",
"assigned_by": "Shae Pagac",
"proposal_id": "4eb443fe-311e-4e4e-975b-0a55aa83efc7",
"professional_avatar": "",
"professional_fullname": "Golden Goodwin",
"professional_username": "golden-goodwin-32ad1afa-37db-469a-95ab-7f2e0c0183b7"
}
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": "June 09, 2021",
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "8d7c45ed-bc3c-48f6-ba7e-1b05834bb58a",
"business_name": "Champlin, Hettinger and Yundt",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWswWWpsaU56STNZUzFqWlRsakxUUTNaamd0WVRJd1pDMWpOR1l5TmpZMFpHVXhOV0lHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--93d4f25595a38e0b978e3bb475b1c0d52ebfd921/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/campaigns/4de333d4-6296-4eae-9d19-9ed5556db32c/jobs/8e445652-692c-492f-8424-d8f5ae6e0b94" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/jobs/:id
GET /api/v1/campaigns/4de333d4-6296-4eae-9d19-9ed5556db32c/jobs/8e445652-692c-492f-8424-d8f5ae6e0b94
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/campaigns/a2fd4eb0-eeb6-4e60-aa94-3494c0e6c5ad/jobs/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: dannie_flatley@adams.net" \
-H "Authorization: p2Zvm9FEX2aVR_9Mr22v" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/campaigns/:campaign_id/jobs/:id
GET /api/v1/campaigns/a2fd4eb0-eeb6-4e60-aa94-3494c0e6c5ad/jobs/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Jobs - Publish Job
Publishes job when status is draft
Request
curl "http://localhost:3000/api/v1/campaigns/e5566aec-714f-4df1-880a-d9cb9ad1b41e/jobs/dcb73f33-fa4d-4093-8a60-cfe5c10e4839/publish" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: mammie@brekkehermann.biz" \
-H "Authorization: yiV8R3mVPTFyg9PFWwAd" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/jobs/:job_id/publish
PATCH /api/v1/campaigns/e5566aec-714f-4df1-880a-d9cb9ad1b41e/jobs/dcb73f33-fa4d-4093-8a60-cfe5c10e4839/publish
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "dcb73f33-fa4d-4093-8a60-cfe5c10e4839",
"type": "job",
"attributes": {
"campaign_name": "Russel, Heidenreich and Haag",
"campaign_id": "e5566aec-714f-4df1-880a-d9cb9ad1b41e",
"title": "Logo designs",
"description": "Mollitia molestias sed. Eligendi temporibus quae. Corporis nihil aut.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "d7ee1c84-ea09-4d05-b06f-fcd36fed6ac4",
"published_by": "d7ee1c84-ea09-4d05-b06f-fcd36fed6ac4",
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "05be8fd7-0bde-4f1a-b980-2cf4991db1ff",
"business_name": "Lindgren and Sons",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWswT0dFNU1ESmxaaTB3TVdSbUxUUTJZV010T0RRMFppMHlPREF6TURkbU16a3lOR1lHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--2ac125cfb8cf46ad6138ed4df49250708a241ed6/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
}
Wrong status when job is not in draft
Request
curl "http://localhost:3000/api/v1/campaigns/805ddc14-458b-4310-b031-f354bf417567/jobs/12394861-0d1f-49bc-9968-7b8014e322a6/publish" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jay.ko@leffler.io" \
-H "Authorization: 7QKP_DWyy3_uis22EKhj" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/jobs/:job_id/publish
PATCH /api/v1/campaigns/805ddc14-458b-4310-b031-f354bf417567/jobs/12394861-0d1f-49bc-9968-7b8014e322a6/publish
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
400 Bad Request
{
"data": {
"errors": {
"detail": "The job is not in the right status for this action to be performed"
}
}
}
Error with missing attributes
Request
curl "http://localhost:3000/api/v1/campaigns/e33ad6b5-62b3-4a8e-8d30-9fcd87f8bf8e/jobs/ee0d4c87-6af4-48a6-8400-74f44633eb55/publish" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: eladia@heller.info" \
-H "Authorization: XQLFEvczhqx5so7vazqv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/jobs/:job_id/publish
PATCH /api/v1/campaigns/e33ad6b5-62b3-4a8e-8d30-9fcd87f8bf8e/jobs/ee0d4c87-6af4-48a6-8400-74f44633eb55/publish
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "ee0d4c87-6af4-48a6-8400-74f44633eb55",
"type": "job",
"errors": [
{
"source": {
"pointer": "/data/attributes/end_date"
},
"detail": "End_date can't be blank",
"title": "can't be blank"
}
]
}
Jobs - Update
Successful with with valid params
Request
curl "http://localhost:3000/api/v1/campaigns/69401c1f-212b-4f18-a576-b0b8edc77dee/jobs/bcb84fe0-7187-4e32-928a-5f88b6ed56ba" -d '{"job":{"description":"Ullam aut mollitia. Ut aut quas. Similique dicta alias.","job_type":"influencer","skills":["Public speaking"],"start_date":"2021-06-10","end_date":"2021-06-13","budget":5000,"professionals_count":2}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: corrie_hansen@daugherty.com" \
-H "Authorization: seei5hjviZ6c7q4gqt2R" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/jobs/:id
PATCH /api/v1/campaigns/69401c1f-212b-4f18-a576-b0b8edc77dee/jobs/bcb84fe0-7187-4e32-928a-5f88b6ed56ba
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"description":"Ullam aut mollitia. Ut aut quas. Similique dicta alias.","job_type":"influencer","skills":["Public speaking"],"start_date":"2021-06-10","end_date":"2021-06-13","budget":5000,"professionals_count":2}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals nedded |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "bcb84fe0-7187-4e32-928a-5f88b6ed56ba",
"type": "job",
"attributes": {
"campaign_name": "Little, Jakubowski and Berge",
"campaign_id": "69401c1f-212b-4f18-a576-b0b8edc77dee",
"title": "Logo designs",
"description": "Ullam aut mollitia. Ut aut quas. Similique dicta alias.",
"job_type": "influencer",
"skills": [
"Public speaking"
],
"end_date": "2021-06-13",
"start_date": "2021-06-10",
"budget": {
"formated_dollar_value": "$5,000",
"formated_naira_value": "₦2,350,000",
"value": 5000
},
"status": "published",
"created_by": "821b3c66-a7d2-4692-942d-f45a26638162",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 2,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 10, 2021",
"end_date": "June 13, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "8275929f-062b-4124-aefe-729a88914343",
"business_name": "Halvorson Group",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxrTXpVM01HUTROeTB6Tm1VeUxUUTFNRFV0WVdWall5MWtZalpsWldNNFpUVXdOV1FHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--c457aefac84f9e7d7209945d90ab1bc4ba1c3b6a/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
}
With invalid params
Request
curl "http://localhost:3000/api/v1/campaigns/8b632dad-e0f5-43f3-851f-10f8785d9b98/jobs/5d79d791-590e-45e7-a6d5-676f373d8a37" -d '{"job":{"title":""}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: kendrick@rau.io" \
-H "Authorization: DpjgDY8xe4cs2EPzHN1H" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/campaigns/:campaign_id/jobs/:id
PATCH /api/v1/campaigns/8b632dad-e0f5-43f3-851f-10f8785d9b98/jobs/5d79d791-590e-45e7-a6d5-676f373d8a37
Accept: application/json
Content-Type: application/json
Parameters
{"job":{"title":""}}
| Name | Description |
|---|---|
| job[title] required | Title of a job |
| job[description] | Description about job |
| job[job_type] required | Type of professionals needed |
| job[skills] | Skills of professionals nedded |
| job[application_deadline] | Deadline for accepting proposals |
| job[start_date] | Expected start date for job |
| job[end_date] | Expected end date for job |
| job[budget] | Planned budget |
| job[professionals_count] | Number of professionals needed |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "5d79d791-590e-45e7-a6d5-676f373d8a37",
"type": "job",
"errors": [
{
"source": {
"pointer": "/data/attributes/title"
},
"detail": "Title can't be blank",
"title": "can't be blank"
}
]
}
Jobs - Delete
Successfully deletes a job
Request
curl "http://localhost:3000/api/v1/campaigns/02a616dc-7249-4abf-b482-6109f0b7f1a2/jobs/c7f175ed-bf16-42d9-800a-39c76d18b225" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ashely_krajcik@huel.info" \
-H "Authorization: Mx7RoQ_6JMYA7kTETpeo" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/campaigns/:campaign_id/jobs/:id
DELETE /api/v1/campaigns/02a616dc-7249-4abf-b482-6109f0b7f1a2/jobs/c7f175ed-bf16-42d9-800a-39c76d18b225
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "bce716f4-f052-408f-a77f-94cbfc5ecf42",
"type": "job",
"attributes": {
"campaign_name": "Rath, Kertzmann and Kreiger",
"campaign_id": "02a616dc-7249-4abf-b482-6109f0b7f1a2",
"title": "Logo designs",
"description": "Error consequatur dolorum. Sunt vel dolorum. Alias aspernatur a.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "15cb73af-b936-4703-b729-4be3e74c55ab",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "dbfb6137-a26f-4702-9730-18b274a137e1",
"business_name": "Buckridge, Parisian and Torphy",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsxWkdabVpETXhZaTB6WXpsbUxUUTJPREl0T1RVeE5TMW1PVGs0TURReE9XWXhZekFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--aa48abea925cf511eb8f77bb9e40246677cdeaa6/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "4a1c6b13-022b-4806-a381-d1802129aadd",
"type": "job",
"attributes": {
"campaign_name": "Rath, Kertzmann and Kreiger",
"campaign_id": "02a616dc-7249-4abf-b482-6109f0b7f1a2",
"title": "Logo designs",
"description": "Dignissimos eaque sequi. Vitae ducimus ipsum. Qui corrupti voluptas.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$50,000",
"formated_naira_value": "₦23,500,000",
"value": 50000
},
"status": "published",
"created_by": "15cb73af-b936-4703-b729-4be3e74c55ab",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "USD",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "dbfb6137-a26f-4702-9730-18b274a137e1",
"business_name": "Buckridge, Parisian and Torphy",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1TmpBNE9HVTJPUzFrTkdVd0xUUmtaV1l0T0RRd055MDRZemszWldGaU1EWmpaallHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--2ba0daeb41ea8d5894e946f96158bbb8c1bb6946/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
}
With another user's job
Request
curl "http://localhost:3000/api/v1/campaigns/cc3b8b6f-1a21-4e81-915d-63ff92da440f/jobs/af8de53f-11bf-48bf-a224-04f09ba75807" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: anderson@larson.io" \
-H "Authorization: h-yht1-G3fEzHUaVyyX1" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/campaigns/:campaign_id/jobs/:id
DELETE /api/v1/campaigns/cc3b8b6f-1a21-4e81-915d-63ff92da440f/jobs/af8de53f-11bf-48bf-a224-04f09ba75807
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Without Authentication
Request
curl "http://localhost:3000/api/v1/campaigns/eaeaf747-7ec4-44b2-bc61-af6b682ac606/jobs/cb79e4bc-d673-4645-bd75-f141dde654e5" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/campaigns/:campaign_id/jobs/:id
DELETE /api/v1/campaigns/eaeaf747-7ec4-44b2-bc61-af6b682ac606/jobs/cb79e4bc-d673-4645-bd75-f141dde654e5
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Jobs - Search
Search without queries/filters returns all records
Request
curl -g "http://localhost:3000/api/v1/jobs/search" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": 2,
"total_pages": 16,
"total_count": 153
}
}
}
Search with query
Request
curl -g "http://localhost:3000/api/v1/jobs/search?query=Newspaper" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?query=Newspaper
Accept: application/json
Content-Type: application/json
Parameters
query: Newspaper
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "1b2a3eb9-1939-4783-8623-b1e534952b3d",
"type": "job",
"attributes": {
"campaign_name": "Wehner-Hilpert",
"campaign_id": "651a3685-b329-4ec2-bce4-3e1e5f58e7ac",
"title": "Headline on Punch Newspaper",
"description": "Soluta eveniet voluptas. Aut quo enim. Maiores quasi nesciunt.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "5b992e5a-61ba-47ad-80ce-0d929f4d7591",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "d6664523-f3cf-4e47-b109-80a24a45153d",
"business_name": "Lesch-Hodkiewicz",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsxT1dRNFlXTXpOeTB6TXpkaExUUTBZalV0WWpNME55MWhOR0UwWTJWaU16UXpORFVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--3fb1afd9a190f2bdef98d7c4dad7c95182d805d1/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search for Campaign name after it's editted
Request
curl -g "http://localhost:3000/api/v1/jobs/search?query=Newspaper" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?query=Newspaper
Accept: application/json
Content-Type: application/json
Parameters
query: Newspaper
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "4f7d64ad-ead2-4adc-b3d6-c41dad355e94",
"type": "job",
"attributes": {
"campaign_name": "Luettgen-Jerde",
"campaign_id": "feb6c98c-c2b7-4274-8d32-8b37303b7bb6",
"title": "Headline on Punch Newspaper",
"description": "Fugit minima rerum. Nihil sit cumque. Ad excepturi laboriosam.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "19ef8528-c6ca-4c25-a2c0-26a96732720e",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "84e42aa2-597c-4393-8792-03dc5016a3d1",
"business_name": "King-Deckow",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt4WVRjM1lURmpaQzFtT0RFNUxUUTJaall0T0RGaU5TMDRZbVZoWkdVME5EVm1OamNHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--9f8adad3880dea9c25a6952e1d2c5bf00a6d5f90/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with job_type
Request
curl -g "http://localhost:3000/api/v1/jobs/search?job_type=creator%2C+publisher" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?job_type=creator%2C+publisher
Accept: application/json
Content-Type: application/json
Parameters
job_type: creator, publisher
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "ebbff9e8-9b75-4103-92b1-95d111f0eef1",
"type": "job",
"attributes": {
"campaign_name": "Tremblay Inc",
"campaign_id": "34b959a6-0be6-41f2-85f3-a41efabc2070",
"title": "Logo designs",
"description": "Quo dicta eos. Error cum veritatis. Blanditiis quae dolorem.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "9fc51443-7b50-4072-8eb6-c29e659ccba2",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "021d7bb7-49a4-4f6a-8225-65509b15a45f",
"business_name": "Bahringer-Anderson",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtWmpKa1lqZG1NUzB6T0Roa0xUUTBaRFF0WW1ZM1pDMHhNRGRpTXpkaE56RmtZMlVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--e274d249cfc5f3b7a7cc909bd5e3d608d542d9df/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "d5b35c52-b3ea-4a1c-abfb-02374ae5282f",
"type": "job",
"attributes": {
"campaign_name": "Tremblay Inc",
"campaign_id": "34b959a6-0be6-41f2-85f3-a41efabc2070",
"title": "Logo designs",
"description": "Voluptatem sunt similique. Qui rerum praesentium. Voluptatibus voluptatem voluptatem.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "9fc51443-7b50-4072-8eb6-c29e659ccba2",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "021d7bb7-49a4-4f6a-8225-65509b15a45f",
"business_name": "Bahringer-Anderson",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtTUdRelpUY3hNaTFrWTJGaUxUUXhNak10T0dNME9TMHpNakV4Tm1NNFlUZzJNR1lHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--dab3f08fa58c8e2f36554ec8206c265f7873b88a/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "325c9150-9802-4111-8faf-a83b0d610d7a",
"type": "job",
"attributes": {
"campaign_name": "Tremblay Inc",
"campaign_id": "34b959a6-0be6-41f2-85f3-a41efabc2070",
"title": "Mural designs",
"description": "Et ipsa consequatur. Doloremque provident ut. Dicta fugit hic.",
"job_type": "creator",
"skills": [
"Mural",
"Painting",
"Designs"
],
"end_date": "2021-07-01",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"status": "published",
"created_by": "9fc51443-7b50-4072-8eb6-c29e659ccba2",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-19",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "July 01, 2021",
"published_at": "7th June, 2021",
"started_at": null,
"application_deadline": "June 19, 2021"
},
"commission_data": null,
"date_published_in_words": "2 days",
"business_id": "021d7bb7-49a4-4f6a-8225-65509b15a45f",
"business_name": "Bahringer-Anderson",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxsWVdSa09EVTRNeTFrT1RNd0xUUmlOV1F0T0RSak15MW1NRFV5T1RWa01qZzBNVGdHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--866264175a8216ed358390ad3d6ef109e0f74afa/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "8b3d312c-1ca1-43e6-a14a-3a702cdb7268",
"type": "job",
"attributes": {
"campaign_name": "Tremblay Inc",
"campaign_id": "34b959a6-0be6-41f2-85f3-a41efabc2070",
"title": "Headline on Punch Newspaper",
"description": "Qui dignissimos deserunt. Qui repellat consequuntur. Ex cupiditate laudantium.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "9fc51443-7b50-4072-8eb6-c29e659ccba2",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "021d7bb7-49a4-4f6a-8225-65509b15a45f",
"business_name": "Bahringer-Anderson",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsxWTJVNE9XUTVZeTA0WldKaExUUmlPRGN0WWpRNFlpMDNNak13WmpoaFpXVTFOVGdHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--5773f48a331e642e6cedc038cf24a8530ee0c294/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Search with skills
Request
curl -g "http://localhost:3000/api/v1/jobs/search?skills=designs" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?skills=designs
Accept: application/json
Content-Type: application/json
Parameters
skills: designs
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "f317c561-476c-4313-ac0e-52a005816b3b",
"type": "job",
"attributes": {
"campaign_name": "Raynor Inc",
"campaign_id": "e111a208-8cf7-440a-8254-13c4899ca5dd",
"title": "Mural designs",
"description": "Corporis dolorum unde. Ut et et. Distinctio qui doloribus.",
"job_type": "creator",
"skills": [
"Mural",
"Painting",
"Designs"
],
"end_date": "2021-07-01",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"status": "published",
"created_by": "f40f306a-9757-4f12-b853-f001416db069",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-19",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "July 01, 2021",
"published_at": "7th June, 2021",
"started_at": null,
"application_deadline": "June 19, 2021"
},
"commission_data": null,
"date_published_in_words": "2 days",
"business_id": "ec6262ff-21dc-45e3-8dba-577a616ab6e9",
"business_name": "Price-Morissette",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsxWmpobVpHWmxZUzAzWkRneExUUTJOekF0T1RnNVlTMHdOMkZoTVdSaE5USXhZalVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--53f10f202730c152f97103b8e5f0aa805b514990/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with minimum_budget
Request
curl -g "http://localhost:3000/api/v1/jobs/search?minimum_budget=9_000¤cy=NGN" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?minimum_budget=9_000&currency=NGN
Accept: application/json
Content-Type: application/json
Parameters
minimum_budget: 9_000
currency: NGN
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "NGN",
"results": {
"data": [
{
"id": "02a2b8d4-4096-4efd-9cc5-1b317187d1ec",
"type": "job",
"attributes": {
"campaign_name": "Konopelski, Cummings and Rosenbaum",
"campaign_id": "877ab2bc-4b32-4e79-80ef-fce44b7b670c",
"title": "Logo designs",
"description": "Sapiente aliquam repellat. Sed dolore molestiae. Iste est ex.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "22326fae-426e-4fee-a896-a2b2c32b0c2d",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "71a1b0e0-040b-4b27-be8e-c73da38ca8ef",
"business_name": "Daugherty, Quigley and Hintz",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1TlRBME4yUTNPQzB6WWpGbExUUXpNak10WVdReE15MDFaRGN6WTJObFltWmlORE1HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--c8243c4e5be7653ff1d3fd5de161807926e2a71f/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "fbd71c5e-5213-481f-8d18-85e426be98f1",
"type": "job",
"attributes": {
"campaign_name": "Konopelski, Cummings and Rosenbaum",
"campaign_id": "877ab2bc-4b32-4e79-80ef-fce44b7b670c",
"title": "Logo designs",
"description": "Suscipit ipsam eligendi. Rem qui ex. Aspernatur quasi eos.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "22326fae-426e-4fee-a896-a2b2c32b0c2d",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "71a1b0e0-040b-4b27-be8e-c73da38ca8ef",
"business_name": "Daugherty, Quigley and Hintz",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1TVRWbE1qTTBNQzB4WmpJMExUUm1ZbVl0WWpZNE9TMDNaVFEyWldOaE5HSXdZMlFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--fc981a3e8d1edab4762c001daf7b58cde265eeb2/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "f97c845e-2d65-4367-a8ec-7521f54721fe",
"type": "job",
"attributes": {
"campaign_name": "Konopelski, Cummings and Rosenbaum",
"campaign_id": "877ab2bc-4b32-4e79-80ef-fce44b7b670c",
"title": "Mural designs",
"description": "Nihil ab voluptatibus. Maxime magnam reiciendis. Ab perspiciatis ipsam.",
"job_type": "creator",
"skills": [
"Mural",
"Painting",
"Designs"
],
"end_date": "2021-07-01",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"status": "published",
"created_by": "22326fae-426e-4fee-a896-a2b2c32b0c2d",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-19",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "July 01, 2021",
"published_at": "7th June, 2021",
"started_at": null,
"application_deadline": "June 19, 2021"
},
"commission_data": null,
"date_published_in_words": "2 days",
"business_id": "71a1b0e0-040b-4b27-be8e-c73da38ca8ef",
"business_name": "Daugherty, Quigley and Hintz",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxoWmprMk56VTJNQzFsT0RjNExUUXpOR1V0T0RsbE5TMDNOR1l5TkRRMk5HRmlPVEFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--4611ca9c3a5b99e61155f4be2d32f7e026565492/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "f121cd3b-ce04-44dc-9403-b22090d959d5",
"type": "job",
"attributes": {
"campaign_name": "Konopelski, Cummings and Rosenbaum",
"campaign_id": "877ab2bc-4b32-4e79-80ef-fce44b7b670c",
"title": "Headline on Punch Newspaper",
"description": "Voluptatem dolore qui. Aut adipisci ut. Sed consequuntur molestias.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "22326fae-426e-4fee-a896-a2b2c32b0c2d",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "71a1b0e0-040b-4b27-be8e-c73da38ca8ef",
"business_name": "Daugherty, Quigley and Hintz",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxoTW1JME9Ua3lOaTAxWldKa0xUUTRabUV0WVRFeFppMWhabVptWmpRellXWTRPRGNHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--3bc0b750d138e5adaceef41e0940ab180f8a2007/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "4754c31f-8c54-4804-9a91-63d1668e596c",
"type": "job",
"attributes": {
"campaign_name": "Konopelski, Cummings and Rosenbaum",
"campaign_id": "877ab2bc-4b32-4e79-80ef-fce44b7b670c",
"title": "Make hashtag to trend on twitter",
"description": "Nam dolor velit. Illum harum omnis. Ratione atque voluptatem.",
"job_type": "influencer",
"skills": [
"Leadership"
],
"end_date": "2021-07-04",
"start_date": "2021-06-20",
"budget": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"status": "published",
"created_by": "22326fae-426e-4fee-a896-a2b2c32b0c2d",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 20, 2021",
"end_date": "July 04, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "71a1b0e0-040b-4b27-be8e-c73da38ca8ef",
"business_name": "Daugherty, Quigley and Hintz",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt5Tmpsak1XSmhNQzAzT1dRNExUUTBPV1V0WWpCa1lpMHdNRFppTlRjMU5EazFOMllHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--75b084db6ab20595c20897fbfe47e483d10df650/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 5
}
}
}
Search with minimum_budget and currency
Request
curl -g "http://localhost:3000/api/v1/jobs/search?minimum_budget=39¤cy=USD" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?minimum_budget=39&currency=USD
Accept: application/json
Content-Type: application/json
Parameters
minimum_budget: 39
currency: USD
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "60738d44-e0ac-464b-998b-35d7f86530de",
"type": "job",
"attributes": {
"campaign_name": "Reichert, Runolfsdottir and Erdman",
"campaign_id": "add2ca7b-7cf4-4260-98d2-c0a454f3e963",
"title": "Logo designs",
"description": "Qui quia quod. Omnis cumque ad. Repudiandae fugiat consequatur.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "46192d72-8401-4134-bc74-27224f7cb294",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "4005955e-a48a-4b44-b20d-96b952525d47",
"business_name": "Christiansen LLC",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtTURBeVlXRTVaQzA0WW1KbExUUTVZelV0WWpZME5pMW1ZV1EwT0RNNE56STVaR0VHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--1b0b9de37642f953ca06065af336fdd485582e5a/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "20501e07-a2eb-4a44-829e-c20a5f394b5b",
"type": "job",
"attributes": {
"campaign_name": "Reichert, Runolfsdottir and Erdman",
"campaign_id": "add2ca7b-7cf4-4260-98d2-c0a454f3e963",
"title": "Logo designs",
"description": "Nam ex deserunt. Blanditiis nam accusantium. Enim quo qui.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "46192d72-8401-4134-bc74-27224f7cb294",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "4005955e-a48a-4b44-b20d-96b952525d47",
"business_name": "Christiansen LLC",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWszTTJRM09HWmpNaTFsTVdVM0xUUm1OVEV0WVRNeE5DMWpPREZoTmpReU5EY3hPVEFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--6efe89a46e8797260fd6c2399c8aec43bc16c098/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 2
}
}
}
Search with maximum_budget
Request
curl -g "http://localhost:3000/api/v1/jobs/search?maximum_budget=7_000¤cy=NGN" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?maximum_budget=7_000&currency=NGN
Accept: application/json
Content-Type: application/json
Parameters
maximum_budget: 7_000
currency: NGN
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "NGN",
"results": {
"data": [
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 0,
"total_count": 0
}
}
}
Search with minimum_budget and maximum_budget
Request
curl -g "http://localhost:3000/api/v1/jobs/search?minimum_budget=5_000&maximum_budget=9_000¤cy=NGN" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?minimum_budget=5_000&maximum_budget=9_000&currency=NGN
Accept: application/json
Content-Type: application/json
Parameters
minimum_budget: 5_000
maximum_budget: 9_000
currency: NGN
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "NGN",
"results": {
"data": [
{
"id": "9ec2f0fa-9251-4eaf-9e8b-eb30312281ca",
"type": "job",
"attributes": {
"campaign_name": "Simonis, Paucek and Rippin",
"campaign_id": "2712e940-c764-4961-9872-06ae15a5a861",
"title": "Make hashtag to trend on twitter",
"description": "Debitis asperiores consequatur. Ut expedita iste. Et repellendus et.",
"job_type": "influencer",
"skills": [
"Leadership"
],
"end_date": "2021-07-04",
"start_date": "2021-06-20",
"budget": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"status": "published",
"created_by": "f46dc4b4-a4b9-407d-9804-06013d4a3226",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 20, 2021",
"end_date": "July 04, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "a0de8e12-98c2-4530-8d5e-2dc16b85ecdc",
"business_name": "Cassin-Howell",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1WldKaU4ySTRPUzFqTXpGaUxUUTFPRFV0T1RNMllTMDJPR00yWkdZeVptRXhaamtHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--a7024312866ee819d52f3721f6554a2c12cf5ff6/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Jobs Search - Sorting
Sorts results in descending order of last updated
Request
curl -g "http://localhost:3000/api/v1/jobs/search?sort=updated_at" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?sort=updated_at
Accept: application/json
Content-Type: application/json
Parameters
sort: updated_at
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "39640e34-c50b-4a7d-a598-2611113e6977",
"type": "job",
"attributes": {
"campaign_name": "Kovacek-Ziemann",
"campaign_id": "ce4c86ca-43a5-4256-91cb-55974974733a",
"title": "Make hashtag to trend on twitter",
"description": "Veritatis sint qui. Quam aut fugit. Quia quisquam quas.",
"job_type": "influencer",
"skills": [
"Leadership"
],
"end_date": "2021-07-04",
"start_date": "2021-06-20",
"budget": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"status": "published",
"created_by": "ca5c8972-4001-49e4-8776-dcb38474afd3",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 20, 2021",
"end_date": "July 04, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "030d6d66-b6ef-4e03-a16c-db57830238d7",
"business_name": "Shanahan-Marks",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs0TnpFNU9UWm1ZUzFrTkRWa0xUUTJZekl0T0dOaU1DMW1ZekEzWm1OaU9ETTBNV01HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--be8a704c3bdada84c46fd15ea2996d0294245bb8/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "60ddf9b4-722c-4e68-8647-7902077d0454",
"type": "job",
"attributes": {
"campaign_name": "Kovacek-Ziemann",
"campaign_id": "ce4c86ca-43a5-4256-91cb-55974974733a",
"title": "Headline on Punch Newspaper",
"description": "Ad ipsa unde. Neque amet labore. Quia sint alias.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "ca5c8972-4001-49e4-8776-dcb38474afd3",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "030d6d66-b6ef-4e03-a16c-db57830238d7",
"business_name": "Shanahan-Marks",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxqTldSa05URTFOaTFsWkROa0xUUmlZell0T1dFMU9TMWtNVGMyTXpZeE5qRXdNalVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--3535506fe082e373dec5c6ea2e41c92b8fc8ba00/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "5abd8115-541e-492b-9694-e260dab33f37",
"type": "job",
"attributes": {
"campaign_name": "Kovacek-Ziemann",
"campaign_id": "ce4c86ca-43a5-4256-91cb-55974974733a",
"title": "Mural designs",
"description": "Quas ut excepturi. Quod ducimus dolore. Delectus saepe est.",
"job_type": "creator",
"skills": [
"Mural",
"Painting",
"Designs"
],
"end_date": "2021-07-01",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"status": "published",
"created_by": "ca5c8972-4001-49e4-8776-dcb38474afd3",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-19",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "July 01, 2021",
"published_at": "7th June, 2021",
"started_at": null,
"application_deadline": "June 19, 2021"
},
"commission_data": null,
"date_published_in_words": "2 days",
"business_id": "030d6d66-b6ef-4e03-a16c-db57830238d7",
"business_name": "Shanahan-Marks",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWswTkdNeFlUazJaaTB4Tm1RNExUUXlPVFl0T0dZNE5TMDJNVGN6TVRObE56aGlOakVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--07db4c797492d8da6c574afe9d52cf4887cf5f50/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "e8e3eb71-925e-489b-86ae-a88e2a0d73e8",
"type": "job",
"attributes": {
"campaign_name": "Kovacek-Ziemann",
"campaign_id": "ce4c86ca-43a5-4256-91cb-55974974733a",
"title": "Logo designs",
"description": "Expedita aut minima. Ea quibusdam magni. Error eos sunt.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "ca5c8972-4001-49e4-8776-dcb38474afd3",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "030d6d66-b6ef-4e03-a16c-db57830238d7",
"business_name": "Shanahan-Marks",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6Wm1OaVlUWXlOaTFsTnpFMkxUUXpZemt0WWprMk15MHhNMkUxWmpnd05qTTRNR1VHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--0b9d88f3df301191dded8d66c84f3f659e4f86f4/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Sorts results in descending order of date published
Request
curl -g "http://localhost:3000/api/v1/jobs/search?sort=published_at" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?sort=published_at
Accept: application/json
Content-Type: application/json
Parameters
sort: published_at
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "1ef2405d-dcae-46a6-9f3e-c975f9260453",
"type": "job",
"attributes": {
"campaign_name": "Robel Group",
"campaign_id": "fa8d34fa-d366-4667-8f65-a8adcc77d1b5",
"title": "Headline on Punch Newspaper",
"description": "Consectetur enim iusto. Sunt veritatis corporis. Eaque est ad.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "af482722-ff5d-4819-b87e-2c34bbc1c395",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "3af8f343-50b2-4a52-82d0-5df8e7f708d5",
"business_name": "Abbott, Steuber and Hessel",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6T0RFM01tTXdNUzFqWWpVMExUUTVZell0T1daaVpDMWpPVFl3T0RNMk1UVXlNV1VHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--cbe85cf8b30f7cb3e7229a8392be7a0df59f71a5/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "c25c0d18-f2ad-4cbe-9e3b-ac435355242c",
"type": "job",
"attributes": {
"campaign_name": "Robel Group",
"campaign_id": "fa8d34fa-d366-4667-8f65-a8adcc77d1b5",
"title": "Make hashtag to trend on twitter",
"description": "Reprehenderit enim aperiam. Officiis et fugiat. Laboriosam consequatur omnis.",
"job_type": "influencer",
"skills": [
"Leadership"
],
"end_date": "2021-07-04",
"start_date": "2021-06-20",
"budget": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"status": "published",
"created_by": "af482722-ff5d-4819-b87e-2c34bbc1c395",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 20, 2021",
"end_date": "July 04, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "3af8f343-50b2-4a52-82d0-5df8e7f708d5",
"business_name": "Abbott, Steuber and Hessel",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWswTldKaU9XRXpPUzB3TTJKbExUUTNNR0V0T0dRME5DMHpOamN5WmpneFpEUmlZamdHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--4570a18b33a2d29fad89ddf8d9ac96dc263eb4f6/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "ba14e633-9bb3-4187-adb8-3a7baf5cec11",
"type": "job",
"attributes": {
"campaign_name": "Robel Group",
"campaign_id": "fa8d34fa-d366-4667-8f65-a8adcc77d1b5",
"title": "Mural designs",
"description": "Et distinctio maxime. Neque dolores voluptatem. Error sed est.",
"job_type": "creator",
"skills": [
"Mural",
"Painting",
"Designs"
],
"end_date": "2021-07-01",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"status": "published",
"created_by": "af482722-ff5d-4819-b87e-2c34bbc1c395",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-19",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "July 01, 2021",
"published_at": "7th June, 2021",
"started_at": null,
"application_deadline": "June 19, 2021"
},
"commission_data": null,
"date_published_in_words": "2 days",
"business_id": "3af8f343-50b2-4a52-82d0-5df8e7f708d5",
"business_name": "Abbott, Steuber and Hessel",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxpTkRka05qWXpZUzFrT0RJM0xUUTRZVEl0WWpSaU1TMHdOemc0TVdKallXTTNNREVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--92af056f9ce291374e50c855cafa23cd059a487f/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "7b1235d5-7eeb-4107-8271-bc57a4b60cb0",
"type": "job",
"attributes": {
"campaign_name": "Robel Group",
"campaign_id": "fa8d34fa-d366-4667-8f65-a8adcc77d1b5",
"title": "Logo designs",
"description": "Magnam beatae non. Quis at commodi. Porro voluptatem nulla.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "af482722-ff5d-4819-b87e-2c34bbc1c395",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "3af8f343-50b2-4a52-82d0-5df8e7f708d5",
"business_name": "Abbott, Steuber and Hessel",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxoTXprM016TTJZUzFrWldKakxUUXpaV1l0WWpGaE55MWpOemxoWm1aaE9ESmtOallHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--6f5dd3f970028867bfdab806e8c13124d60dadf7/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Sorts results in descending order of budget
Request
curl -g "http://localhost:3000/api/v1/jobs/search?sort=budget" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?sort=budget
Accept: application/json
Content-Type: application/json
Parameters
sort: budget
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "9e1a6c36-d2fa-4c2b-bb51-d8b3fb263c00",
"type": "job",
"attributes": {
"campaign_name": "Padberg Group",
"campaign_id": "287002df-eed9-4d4a-88fb-698f45ead3e9",
"title": "Logo designs",
"description": "Et excepturi voluptatem. Minima quia quasi. Non nam non.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "8e25b02f-397e-40f1-83ba-34abdc0d95dd",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "bd8e7f1a-27f6-436c-b594-ebbae61fa39e",
"business_name": "Leannon LLC",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt3TjJNME0yUTBPUzFrWVRZeExUUTROVFV0WWpkbFppMWtZbVZqTm1aaVpHUmpPV1FHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--8428d26c32b74a3f3c7f9e7f92cc39a867442aa7/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "a6215fe3-d5ab-4404-a060-d97c2d0bac8e",
"type": "job",
"attributes": {
"campaign_name": "Padberg Group",
"campaign_id": "287002df-eed9-4d4a-88fb-698f45ead3e9",
"title": "Mural designs",
"description": "Animi harum eveniet. Modi nostrum optio. Magni labore deserunt.",
"job_type": "creator",
"skills": [
"Mural",
"Painting",
"Designs"
],
"end_date": "2021-07-01",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"status": "published",
"created_by": "8e25b02f-397e-40f1-83ba-34abdc0d95dd",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-19",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "July 01, 2021",
"published_at": "7th June, 2021",
"started_at": null,
"application_deadline": "June 19, 2021"
},
"commission_data": null,
"date_published_in_words": "2 days",
"business_id": "bd8e7f1a-27f6-436c-b594-ebbae61fa39e",
"business_name": "Leannon LLC",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWswWkRneU9EQTJaUzFrWWpoakxUUTVNMkl0WVdOaE5pMHdZV1ZtTXpJeU9EWTNORFFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--66600369a34f44c45a310e59e773b20f985fffa5/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "fae30024-c85e-4463-974e-1f4eb593a085",
"type": "job",
"attributes": {
"campaign_name": "Padberg Group",
"campaign_id": "287002df-eed9-4d4a-88fb-698f45ead3e9",
"title": "Headline on Punch Newspaper",
"description": "Modi occaecati eum. Ut ut rerum. Temporibus vero consectetur.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "8e25b02f-397e-40f1-83ba-34abdc0d95dd",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "bd8e7f1a-27f6-436c-b594-ebbae61fa39e",
"business_name": "Leannon LLC",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxrTm1NNVpqaGpaaTFsTXpBekxUUTFNelF0T1dFd09DMWpZMk16T1dVMk9Ea3dNRGNHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--80f08a9e07c0a43bee075d14dba86eb4697b4c4f/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "267945f7-dfd0-49c2-b5eb-9171fb358c1b",
"type": "job",
"attributes": {
"campaign_name": "Padberg Group",
"campaign_id": "287002df-eed9-4d4a-88fb-698f45ead3e9",
"title": "Make hashtag to trend on twitter",
"description": "Saepe veritatis vel. Labore beatae voluptatem. Sapiente repudiandae nobis.",
"job_type": "influencer",
"skills": [
"Leadership"
],
"end_date": "2021-07-04",
"start_date": "2021-06-20",
"budget": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"status": "published",
"created_by": "8e25b02f-397e-40f1-83ba-34abdc0d95dd",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 20, 2021",
"end_date": "July 04, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "bd8e7f1a-27f6-436c-b594-ebbae61fa39e",
"business_name": "Leannon LLC",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt4T0Rjek4ySTFOUzAyWWpCakxUUXdaREV0T1dNMVl5MHhZemt4TVRkaE1qVmpNbVVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--2c964e1283782c9ce68b983b0c86a9e6edd78b72/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Sorts in descending order of application deadline
Request
curl -g "http://localhost:3000/api/v1/jobs/search?sort=application_deadline" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/search
GET /api/v1/jobs/search?sort=application_deadline
Accept: application/json
Content-Type: application/json
Parameters
sort: application_deadline
| Name | Description |
|---|---|
| query | Text entered by the user |
| job_type | Filter by job_type |
| skills | Filter by skills |
| minimum_budget | Filter by minimum_budget |
| maximum_budget | Filter by maximum_budget |
| currency | Currency selected by user - NGN/USD. Default - NGN |
| sort | Sorts records in decending order. Values include updated_at, published_at, budget and application_deadline |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "2ec4ed74-9859-416d-8a5a-6374095e1082",
"type": "job",
"attributes": {
"campaign_name": "Kling-Schaden",
"campaign_id": "148f2826-6da3-4e25-8d1f-c1874c4e0475",
"title": "Mural designs",
"description": "Debitis beatae molestias. Magni sit quidem. Laborum et beatae.",
"job_type": "creator",
"skills": [
"Mural",
"Painting",
"Designs"
],
"end_date": "2021-07-01",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"status": "published",
"created_by": "aa92b984-43f8-4370-b239-a33d6f7df964",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-19",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "July 01, 2021",
"published_at": "7th June, 2021",
"started_at": null,
"application_deadline": "June 19, 2021"
},
"commission_data": null,
"date_published_in_words": "2 days",
"business_id": "72b0de01-ecdf-4497-933e-4cdddcaddf80",
"business_name": "Veum Group",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt4WXpVMVptUmlNeTB4TmpsbExUUTJOVEV0WWpKa1pTMHdNams1TVdFd04yRXhZamdHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--4c97d2772cd743a6568e8595bdb89ee4ba7c37fc/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "2462b429-dd9a-411c-a4e5-edb125a067aa",
"type": "job",
"attributes": {
"campaign_name": "Kling-Schaden",
"campaign_id": "148f2826-6da3-4e25-8d1f-c1874c4e0475",
"title": "Headline on Punch Newspaper",
"description": "Architecto ex consequatur. Accusamus ut et. Ut non autem.",
"job_type": "publisher",
"skills": [
"Editing",
"Writing"
],
"end_date": "2021-06-24",
"start_date": "2021-06-24",
"budget": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"status": "published",
"created_by": "aa92b984-43f8-4370-b239-a33d6f7df964",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-16",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 24, 2021",
"end_date": "June 24, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 16, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "72b0de01-ecdf-4497-933e-4cdddcaddf80",
"business_name": "Veum Group",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsyWmpJNVlXSTJPQzA1WkRCa0xUUXdOVGN0WVRKaVlTMW1NR05oWWpsaFpEQTFPREFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--c62d06b929827b577e8611effee324229fa56c0c/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "49a0f3d8-caf9-41f3-b178-bb7399dc388e",
"type": "job",
"attributes": {
"campaign_name": "Kling-Schaden",
"campaign_id": "148f2826-6da3-4e25-8d1f-c1874c4e0475",
"title": "Logo designs",
"description": "Optio et dolorum. Et quo atque. Ducimus quos perferendis.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"end_date": "2021-06-19",
"start_date": "2021-06-12",
"budget": {
"formated_dollar_value": "$106.38",
"formated_naira_value": "₦50,000",
"value": 50000
},
"status": "published",
"created_by": "aa92b984-43f8-4370-b239-a33d6f7df964",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": null,
"business_id": "72b0de01-ecdf-4497-933e-4cdddcaddf80",
"business_name": "Veum Group",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsxWW1SbVpqbGtZeTB5T0RVMExUUTRabVV0T1dJNFlpMWtZV00xWVRCall6VXhOVFlHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--9b3dacb06eae00217b8d3d75cf163401f28b0ee9/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
},
{
"id": "c8442b1f-42b5-413f-8cd9-568075a3cd84",
"type": "job",
"attributes": {
"campaign_name": "Kling-Schaden",
"campaign_id": "148f2826-6da3-4e25-8d1f-c1874c4e0475",
"title": "Make hashtag to trend on twitter",
"description": "Non expedita et. Voluptas et blanditiis. Sit nesciunt ut.",
"job_type": "influencer",
"skills": [
"Leadership"
],
"end_date": "2021-07-04",
"start_date": "2021-06-20",
"budget": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"status": "published",
"created_by": "aa92b984-43f8-4370-b239-a33d6f7df964",
"published_by": null,
"started_by": null,
"completed_at": null,
"completed_by": null,
"assigned": [
],
"archived_at": null,
"archived_by": null,
"application_deadline": "2021-06-14",
"professionals_count": 1,
"currency": "NGN",
"budget_hidden": false,
"hidden": false,
"created_at": "2021-06-09",
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 20, 2021",
"end_date": "July 04, 2021",
"published_at": "9th June, 2021",
"started_at": null,
"application_deadline": "June 14, 2021"
},
"commission_data": null,
"date_published_in_words": "about 9 hours",
"business_id": "72b0de01-ecdf-4497-933e-4cdddcaddf80",
"business_name": "Veum Group",
"business_avg_ratings": 0.0,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt5T1RGaFpEZGhZeTB5WkRRNExUUmpaall0T0RVNFpDMDNNVFEwTm1SbU1tRTBOMkVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--90703dbe50fcc29b47d8688b3ba2cfe888570291/fruits.jpeg"
}
],
"is_acceptable": true,
"invited_professionals": [
],
"hidden_campaign_name": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Jobs Search - Autocomplete
Returns an array of suggestions
Request
curl -g "http://localhost:3000/api/v1/jobs/autocomplete?query=design" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/jobs/autocomplete
GET /api/v1/jobs/autocomplete?query=design
Accept: application/json
Content-Type: application/json
Parameters
query: design
| Name | Description |
|---|---|
| query | Text entered by the user |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
"Hall of Fame Mural <em>Design</em>",
"Graphic <em>design</em>s",
"Logo <em>design</em>s"
]
Negotiations - Negotiating
Business creating a negotiation
Request
curl "http://localhost:3000/api/v1/proposals/edf053cb-793c-4faf-89cc-c21084bcc5be/negotiations" -d '{"negotiation":{"post_with_photo_fee":2000,"post_with_carousel_fee":3000,"post_with_video_fee":4000,"story_fee":3000,"live_video_fee":5000,"feedback":"Sint dolor sed. Odit eum et. Nihil aut optio."}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: arnold_gaylord@beergutkowski.org" \
-H "Authorization: kyZKZ-AWfQcK7r2xhvsN" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/proposals/:proposal_id/negotiations
POST /api/v1/proposals/edf053cb-793c-4faf-89cc-c21084bcc5be/negotiations
Accept: application/json
Content-Type: application/json
Parameters
{"negotiation":{"post_with_photo_fee":2000,"post_with_carousel_fee":3000,"post_with_video_fee":4000,"story_fee":3000,"live_video_fee":5000,"feedback":"Sint dolor sed. Odit eum et. Nihil aut optio."}}
| Name | Description |
|---|---|
| negotiation[fee] | Charged amount - Creator/Publisher |
| negotiation[post_with_photo_fee] | Influencer Fee for posts with photos |
| negotiation[post_with_carousel_fee] | Influencer Fee for post with carousel |
| negotiation[post_with_video_fee] | Influencer Fee for posts with video |
| negotiation[story_fee] | Influencer Fee for story |
| negotiation[live_video_fee] | Influencer Fee for live video |
| negotiation[feedback] required | Reason for negotiating |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "edf053cb-793c-4faf-89cc-c21084bcc5be",
"type": "proposal",
"attributes": {
"summary": "Culpa praesentium molestiae. Ipsa non ipsam. Magni facere nihil.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "negotiating",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "7734befa-b597-4c16-b187-52abb5e5abc4",
"fullname": "Douglass Auer",
"username": "douglass-auer-dc0ed804-e97b-4043-9c56-3597c52fe806",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "acc54e82-a349-4cb6-977e-16b1d60e9789",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "4d1d95a5-0e82-4f07-9268-908f15828d4b",
"title": "Logo designs",
"description": "Fuga aut laborum. Consequatur beatae non. Eos autem nam.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Howell and Sons",
"campaign_hashtag": null,
"campaign_keyword": null,
"business_wallet_id": "a6b3408f-9670-4929-ab77-bfbca619657f",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
{
"id": "e1421114-6a15-4f24-8e9f-573f9d2f8e98",
"type": "negotiation",
"attributes": {
"fullname": "Ayana Dooley",
"created_by": "Business",
"feedback": "Sint dolor sed. Odit eum et. Nihil aut optio.",
"created_at": "2021-06-09T07:57:49.048Z",
"currency": "USD",
"created_at_in_words": "less than a minute",
"fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"story_fee": {
"formated_dollar_value": "$3,000",
"formated_naira_value": "₦1,410,000",
"dollar_value": 3000,
"naira_value": 1410000
},
"live_video_fee": {
"formated_dollar_value": "$5,000",
"formated_naira_value": "₦2,350,000",
"dollar_value": 5000,
"naira_value": 2350000
},
"post_with_photo_fee": {
"formated_dollar_value": "$2,000",
"formated_naira_value": "₦940,000",
"dollar_value": 2000,
"naira_value": 940000
},
"post_with_video_fee": {
"formated_dollar_value": "$4,000",
"formated_naira_value": "₦1,880,000",
"dollar_value": 4000,
"naira_value": 1880000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$3,000",
"formated_naira_value": "₦1,410,000",
"dollar_value": 3000,
"naira_value": 1410000
}
}
}
]
}
}
}
}
Professional responding to a negotiation
Request
curl "http://localhost:3000/api/v1/proposals/f498aaeb-ae86-481a-a596-4d3d774334b9/negotiations" -d '{"negotiation":{"fee":23500,"feedback":"Ex optio ullam. Quia est quam. Architecto nam dolorem."}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: cori.littel@schiller.name" \
-H "Authorization: Ny5LgfR147z_-h7zmoHx" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/proposals/:proposal_id/negotiations
POST /api/v1/proposals/f498aaeb-ae86-481a-a596-4d3d774334b9/negotiations
Accept: application/json
Content-Type: application/json
Parameters
{"negotiation":{"fee":23500,"feedback":"Ex optio ullam. Quia est quam. Architecto nam dolorem."}}
| Name | Description |
|---|---|
| negotiation[fee] | Charged amount - Creator/Publisher |
| negotiation[post_with_photo_fee] | Influencer Fee for posts with photos |
| negotiation[post_with_carousel_fee] | Influencer Fee for post with carousel |
| negotiation[post_with_video_fee] | Influencer Fee for posts with video |
| negotiation[story_fee] | Influencer Fee for story |
| negotiation[live_video_fee] | Influencer Fee for live video |
| negotiation[feedback] required | Reason for negotiating |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "f498aaeb-ae86-481a-a596-4d3d774334b9",
"type": "proposal",
"attributes": {
"summary": "Accusamus porro distinctio. Rerum autem aut. Ipsa eligendi aliquam.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "negotiating",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "902e6cab-ec36-48e4-bc4e-ee6c28bf8b64",
"fullname": "Eura Ullrich",
"username": "eura-ullrich-6a9148d1-bfc4-4804-a627-3521d3ced9f2",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "aaa0411b-fc27-4d39-ba00-68f53628bee1",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "de522ff9-6b2c-4586-a17d-4fcd1a78b05d",
"title": "Logo designs",
"description": "Neque illo reprehenderit. Corporis aperiam perferendis. Sit tempora autem.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Hoppe and Sons",
"campaign_hashtag": null,
"campaign_keyword": null,
"business_wallet_id": "617d3ba4-5f1c-4a31-8741-00c0dbe015c0",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
{
"id": "9636bb75-90ce-4c4a-aecf-d856f31685e0",
"type": "negotiation",
"attributes": {
"fullname": "Eura Ullrich",
"created_by": "Professional",
"feedback": "Ex optio ullam. Quia est quam. Architecto nam dolorem.",
"created_at": "2021-06-09T07:57:49.549Z",
"currency": "USD",
"created_at_in_words": "less than a minute",
"fee": {
"formated_dollar_value": "$23,500",
"formated_naira_value": "₦11,045,000",
"dollar_value": 23500,
"naira_value": 11045000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
}
}
}
]
}
}
}
}
Without required feedback
Request
curl "http://localhost:3000/api/v1/proposals/2997bacb-7da2-4f8e-992b-d7e7e76327d6/negotiations" -d '{"negotiation":{"fee":22000}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: florence_mayert@kutch.info" \
-H "Authorization: QgEWFW57TwhPkxRyAxDZ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/proposals/:proposal_id/negotiations
POST /api/v1/proposals/2997bacb-7da2-4f8e-992b-d7e7e76327d6/negotiations
Accept: application/json
Content-Type: application/json
Parameters
{"negotiation":{"fee":22000}}
| Name | Description |
|---|---|
| negotiation[fee] | Charged amount - Creator/Publisher |
| negotiation[post_with_photo_fee] | Influencer Fee for posts with photos |
| negotiation[post_with_carousel_fee] | Influencer Fee for post with carousel |
| negotiation[post_with_video_fee] | Influencer Fee for posts with video |
| negotiation[story_fee] | Influencer Fee for story |
| negotiation[live_video_fee] | Influencer Fee for live video |
| negotiation[feedback] required | Reason for negotiating |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "negotiation",
"errors": [
{
"source": {
"pointer": "/data/attributes/feedback"
},
"detail": "Feedback can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/proposals/b4f9d523-833e-4484-8ff5-a1b2e012c75f/negotiations" -d '{"negotiation":{"fee":22000,"feedback":"A ut magnam. Similique ea aut. Quis magni aliquam."}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/proposals/:proposal_id/negotiations
POST /api/v1/proposals/b4f9d523-833e-4484-8ff5-a1b2e012c75f/negotiations
Accept: application/json
Content-Type: application/json
Parameters
{"negotiation":{"fee":22000,"feedback":"A ut magnam. Similique ea aut. Quis magni aliquam."}}
| Name | Description |
|---|---|
| negotiation[fee] | Charged amount - Creator/Publisher |
| negotiation[post_with_photo_fee] | Influencer Fee for posts with photos |
| negotiation[post_with_carousel_fee] | Influencer Fee for post with carousel |
| negotiation[post_with_video_fee] | Influencer Fee for posts with video |
| negotiation[story_fee] | Influencer Fee for story |
| negotiation[live_video_fee] | Influencer Fee for live video |
| negotiation[feedback] required | Reason for negotiating |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Negotiations - Accepting Negotiations
Professional accepting a business negotiation
Request
curl "http://localhost:3000/api/v1/proposals/f0bd6fbd-5c2f-403c-9295-d07944a08598/negotiations/5e29dae3-bc29-457f-82cd-83d1a382e7d4/accept" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: karri.gleichner@gaylordlangosh.name" \
-H "Authorization: ksxrwyd1VbZcHwb3LSqS" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/accept
PATCH /api/v1/proposals/f0bd6fbd-5c2f-403c-9295-d07944a08598/negotiations/5e29dae3-bc29-457f-82cd-83d1a382e7d4/accept
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
Business accepting a professional negotiation
Request
curl "http://localhost:3000/api/v1/proposals/bed54e25-3b6f-46d8-bafc-1daf4855e89b/negotiations/5fc42d34-6261-48d7-bd3f-9ab6f4301040/accept" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: mauro@rolfsonhintz.net" \
-H "Authorization: zJvv9jB7oZQNd_YAz8nf" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/accept
PATCH /api/v1/proposals/bed54e25-3b6f-46d8-bafc-1daf4855e89b/negotiations/5fc42d34-6261-48d7-bd3f-9ab6f4301040/accept
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
Professional accepting a professional negotiation
Request
curl "http://localhost:3000/api/v1/proposals/0120cf50-8934-4aac-a759-e06180b037e5/negotiations/830724ad-1c36-4b33-a158-4f3ec95fa52e/accept" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ahmed@greenholt.co" \
-H "Authorization: MWPcneL71oeNfyjwZuL7" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/accept
PATCH /api/v1/proposals/0120cf50-8934-4aac-a759-e06180b037e5/negotiations/830724ad-1c36-4b33-a158-4f3ec95fa52e/accept
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "830724ad-1c36-4b33-a158-4f3ec95fa52e",
"type": "negotiation",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base You are not authorized to accept this negotiation",
"title": "You are not authorized to accept this negotiation"
}
]
}
Business accepting a business negotiation
Request
curl "http://localhost:3000/api/v1/proposals/f262c085-f0c2-401e-b5dc-730712a82cb0/negotiations/e704dcc4-2524-450e-a1b9-36a5e2995268/accept" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: deena@langoshjast.info" \
-H "Authorization: d_Rz9Qsng-WqnFbuRVUU" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/accept
PATCH /api/v1/proposals/f262c085-f0c2-401e-b5dc-730712a82cb0/negotiations/e704dcc4-2524-450e-a1b9-36a5e2995268/accept
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "e704dcc4-2524-450e-a1b9-36a5e2995268",
"type": "negotiation",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base You are not authorized to accept this negotiation",
"title": "You are not authorized to accept this negotiation"
}
]
}
Negotiations - Rejecting Negotiations
Professional rejecting a business negotiation
Request
curl "http://localhost:3000/api/v1/proposals/f93c9efc-ef25-46a3-9a4a-4d90c7ff4a6a/negotiations/ff7f3ac4-2a57-4eb5-9b5f-c60fb09c07c4/reject" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: rigoberto_cummerata@cummerataschulist.biz" \
-H "Authorization: i2ViGxB42kpPiFfAzxEQ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/reject
PATCH /api/v1/proposals/f93c9efc-ef25-46a3-9a4a-4d90c7ff4a6a/negotiations/ff7f3ac4-2a57-4eb5-9b5f-c60fb09c07c4/reject
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
Business rejecting a professional negotiation
Request
curl "http://localhost:3000/api/v1/proposals/272b1612-ebf0-4cb6-afba-b77704f33c09/negotiations/69404fba-0f17-46e4-82b8-f5aefc8fb2b9/reject" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: analisa@lueilwitz.com" \
-H "Authorization: M4ycWRP97xTa8aF3zzd_" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/reject
PATCH /api/v1/proposals/272b1612-ebf0-4cb6-afba-b77704f33c09/negotiations/69404fba-0f17-46e4-82b8-f5aefc8fb2b9/reject
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
Professional rejecting a professional negotiation
Request
curl "http://localhost:3000/api/v1/proposals/67dbf4b7-c1b4-4716-9641-99ae01202280/negotiations/9a56831f-03ab-4e9d-9333-e3945dce7423/reject" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: dexter@bogisichhuels.info" \
-H "Authorization: ejcSafxbftup5PVFWBV8" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/reject
PATCH /api/v1/proposals/67dbf4b7-c1b4-4716-9641-99ae01202280/negotiations/9a56831f-03ab-4e9d-9333-e3945dce7423/reject
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "67dbf4b7-c1b4-4716-9641-99ae01202280",
"type": "proposal",
"errors": [
]
}
Business rejecting a business negotiation
Request
curl "http://localhost:3000/api/v1/proposals/d5e6f53e-cb37-435b-b8e9-9a514dea7293/negotiations/bd81ff19-3b58-4ee8-a55b-332d519680d9/reject" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: milford@dickikshlerin.co" \
-H "Authorization: k4_W2j87LkofcLN6SZxu" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/proposals/:proposal_id/negotiations/:negotiation_id/reject
PATCH /api/v1/proposals/d5e6f53e-cb37-435b-b8e9-9a514dea7293/negotiations/bd81ff19-3b58-4ee8-a55b-332d519680d9/reject
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "d5e6f53e-cb37-435b-b8e9-9a514dea7293",
"type": "proposal",
"errors": [
]
}
Plans - Get All
Getting monthly marketplace plans
Request
curl -g "http://localhost:3000/api/v1/plans?product_type=plaqad_marketplace&frequency=monthly" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plans
GET /api/v1/plans?product_type=plaqad_marketplace&frequency=monthly
Accept: application/json
Content-Type: application/json
Parameters
product_type: plaqad_marketplace
frequency: monthly
| Name | Description |
|---|---|
| product_type required | plaqad_marketplace or plaqad_iq |
| currency required | Currency for authenticated user |
| frequency | monthly or yearly |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"plaqad_iq": {
"monthly": {
"plans": {
"data": [
]
}
},
"yearly": {
"plans": {
"data": [
{
"id": "4d349023-246d-4075-9480-ae15b0fd9c37",
"type": "plan",
"attributes": {
"funding_source_plan_id": "price_1HyDGOIy",
"title": "Starter yearly",
"description": "Yearly plan for professionals & small organizations",
"amount": 348,
"currency": "USD",
"frequency": "yearly",
"allowed_proposals_count": null,
"allowed_campaigns_count": null,
"allowed_posts_count": 6000,
"allowed_reports_count": 0,
"product_type": "plaqad_iq",
"number": null
}
}
]
}
}
},
"plaqad_marketplace": {
"monthly": {
"plans": {
"data": [
{
"id": "ccf2e396-aec3-4932-beee-699825131293",
"type": "plan",
"attributes": {
"funding_source_plan_id": null,
"title": "Basic",
"description": "Free plan",
"amount": 0,
"currency": "USD",
"frequency": "free",
"allowed_proposals_count": 10,
"allowed_campaigns_count": 2,
"allowed_posts_count": 0,
"allowed_reports_count": 0,
"product_type": "plaqad_marketplace",
"number": null
}
},
{
"id": "8e9a994e-5e4b-47dc-8612-c5b07eacc518",
"type": "plan",
"attributes": {
"funding_source_plan_id": "priHysj",
"title": "Starter monthly",
"description": "For professionals & small organizations",
"amount": 29,
"currency": "USD",
"frequency": "monthly",
"allowed_proposals_count": 50,
"allowed_campaigns_count": 5,
"allowed_posts_count": 3000,
"allowed_reports_count": 5,
"product_type": "plaqad_marketplace",
"number": null
}
}
]
}
},
"yearly": {
"plans": {
"data": [
{
"id": "ccf2e396-aec3-4932-beee-699825131293",
"type": "plan",
"attributes": {
"funding_source_plan_id": null,
"title": "Basic",
"description": "Free plan",
"amount": 0,
"currency": "USD",
"frequency": "free",
"allowed_proposals_count": 10,
"allowed_campaigns_count": 2,
"allowed_posts_count": 0,
"allowed_reports_count": 0,
"product_type": "plaqad_marketplace",
"number": null
}
}
]
}
}
}
}
Getting yearly NGN plaqad_iq plans
Request
curl -g "http://localhost:3000/api/v1/plans?product_type=plaqad_iq¤cy=NGN&frequency=yearly" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plans
GET /api/v1/plans?product_type=plaqad_iq&currency=NGN&frequency=yearly
Accept: application/json
Content-Type: application/json
Parameters
product_type: plaqad_iq
currency: NGN
frequency: yearly
| Name | Description |
|---|---|
| product_type required | plaqad_marketplace or plaqad_iq |
| currency required | Currency for authenticated user |
| frequency | monthly or yearly |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"plaqad_iq": {
"monthly": {
"plans": {
"data": [
]
}
},
"yearly": {
"plans": {
"data": [
{
"id": "7f50a01a-eee1-4539-b30d-99876c5b24a5",
"type": "plan",
"attributes": {
"funding_source_plan_id": "PLN_2aoqrqj4hivbdxe",
"title": "Starter yearly",
"description": "Yearly plan for professionals & small organizations",
"amount": 163500,
"currency": "NGN",
"frequency": "yearly",
"allowed_proposals_count": null,
"allowed_campaigns_count": null,
"allowed_posts_count": 6000,
"allowed_reports_count": 0,
"product_type": "plaqad_iq",
"number": null
}
}
]
}
}
},
"plaqad_marketplace": {
"monthly": {
"plans": {
"data": [
{
"id": "f4abb896-fe5e-4459-b0e8-f0b714c403c2",
"type": "plan",
"attributes": {
"funding_source_plan_id": null,
"title": "Basic",
"description": "Free plan",
"amount": 0,
"currency": "NGN",
"frequency": "free",
"allowed_proposals_count": 10,
"allowed_campaigns_count": 2,
"allowed_posts_count": 0,
"allowed_reports_count": 0,
"product_type": "plaqad_marketplace",
"number": null
}
},
{
"id": "fe0f1c31-ae73-44fb-ba0b-30f5bd03587c",
"type": "plan",
"attributes": {
"funding_source_plan_id": "PLN_w81nzetc1k3mxmr",
"title": "Starter monthly",
"description": "For professionals & small organizations",
"amount": 13600,
"currency": "NGN",
"frequency": "monthly",
"allowed_proposals_count": 50,
"allowed_campaigns_count": 5,
"allowed_posts_count": 3000,
"allowed_reports_count": 5,
"product_type": "plaqad_marketplace",
"number": null
}
}
]
}
},
"yearly": {
"plans": {
"data": [
{
"id": "f4abb896-fe5e-4459-b0e8-f0b714c403c2",
"type": "plan",
"attributes": {
"funding_source_plan_id": null,
"title": "Basic",
"description": "Free plan",
"amount": 0,
"currency": "NGN",
"frequency": "free",
"allowed_proposals_count": 10,
"allowed_campaigns_count": 2,
"allowed_posts_count": 0,
"allowed_reports_count": 0,
"product_type": "plaqad_marketplace",
"number": null
}
}
]
}
}
}
}
Auto-Suggestion Search - Get Users
Search on Twitter
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/social_account_search?search=omeni&provider=twitter" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/social_account_search
GET /api/v1/plaqad_iq/social_account_search?search=omeni&provider=twitter
Accept: application/json
Content-Type: application/json
Parameters
search: omeni
provider: twitter
| Name | Description |
|---|---|
| search | Social account username in search |
| provider | Social media platform to search from |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"name": "Trace",
"username": "@tracef"
},
{
"name": "Trace Fryar",
"username": "@tracef8"
},
{
"name": "mTw | traceF",
"username": "@400k228"
},
{
"name": "'Nicole Fresh '",
"username": "@NicoleTracef144"
},
{
"name": "Trace Ramirez",
"username": "@tracef71"
},
{
"name": "Trace Fritz",
"username": "@Tracef62"
},
{
"name": "tracey francis",
"username": "@tracef21"
},
{
"name": "tracy ferrier",
"username": "@tracef1971"
},
{
"name": "Tracey",
"username": "@tracef141"
},
{
"name": "Trace",
"username": "@Tracef2017Trace"
},
{
"name": "tracefOFC",
"username": "@TracefOfc"
},
{
"name": "Tracey Flear",
"username": "@tracef1972"
},
{
"name": "xshhdhgx",
"username": "@tracef42"
},
{
"name": "坂本",
"username": "@TracefVF88NvPvT"
},
{
"name": "Tracey Webb",
"username": "@Tracef7884"
},
{
"name": "Влад",
"username": "@tracef1w"
},
{
"name": "Teacey",
"username": "@TeaceyTracef63"
},
{
"name": "tracey francis",
"username": "@Tracef85"
}
]
Search on Youtube
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/social_account_search?search=Odinmaumah&provider=youtube" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/social_account_search
GET /api/v1/plaqad_iq/social_account_search?search=Odinmaumah&provider=youtube
Accept: application/json
Content-Type: application/json
Parameters
search: Odinmaumah
provider: youtube
| Name | Description |
|---|---|
| search | Social account username in search |
| provider | Social media platform to search from |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"id": "UCAmh1DexLGc",
"name": "Derek Barnes",
"username": "Odinma Umah",
"avatar": "https://i.ytimg.com/vi/8wlRAYdb9l0/default.jpg",
"verified": false
},
{
"id": "UCAmh1DexLGcMtDlzMCIxo4w",
"name": "Derek Barnes",
"username": "Descriptive Search Deletion Bug",
"avatar": "https://i.ytimg.com/vi/j3vkdVJj7d0/default.jpg",
"verified": false
},
{
"id": "UCAmh1DexLGcMtDlzMCIxo4w",
"name": "Derek Barnes",
"username": "Descriptive Search Bugs",
"avatar": "https://i.ytimg.com/vi/lBgoO8A_25s/default.jpg",
"verified": false
},
{
"id": "UCAmh1DexLGcMtDlzMCIxo4w",
"name": "Derek Barnes",
"username": "CMS Selector Bugs",
"avatar": "https://i.ytimg.com/vi/dNJSu6_AURs/default.jpg",
"verified": false
}
]
Search on Instagram
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/social_account_search?search=bluebottle&provider=instagram" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/social_account_search
GET /api/v1/plaqad_iq/social_account_search?search=bluebottle&provider=instagram
Accept: application/json
Content-Type: application/json
Parameters
search: bluebottle
provider: instagram
| Name | Description |
|---|---|
| search | Social account username in search |
| provider | Social media platform to search from |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
{
"name": "Blue Bottle Coffee",
"username": "bluebottle",
"avatar": "https://scontent.flos8-1.fna.fbcdn.net/v/t51.2885-15/54169"
}
]
PlaqadIq - Create New Records
Successful with valid params
Request
curl "http://localhost:3000/api/v1/plaqad_iq/trackers" -d '{"tracker":{"tracker_type":"hashtag","tracker_name":"#EndSars","platforms":["twitter","instagram"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: minda_runolfon@morar.info" \
-H "Authorization: EJPv-XJ8Suh9xNYxEK1J" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/plaqad_iq/trackers
POST /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{"tracker":{"tracker_type":"hashtag","tracker_name":"#EndSars","platforms":["twitter","instagram"]}}
| Name | Description |
|---|---|
| tracker[tracker_type] required | Name of tracker |
| tracker[tracker_name] required | Description about tracker |
| tracker[platforms] required | Professionals needed |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "3186c6f0-7044-4677-a3c3-9395f5db3219",
"type": "plaqad_iq_tracker",
"attributes": {
"tracker_name": "#EndSars",
"tracker_type": "hashtag",
"platforms": [
"twitter",
"instagram"
],
"status": "active",
"created_by": "Eladia Brakus",
"created_date": "Jun 9, 2021 07:57 AM"
}
}
}
Successful with valid params
Request
curl "http://localhost:3000/api/v1/plaqad_iq/trackers" -d '{"tracker":{"tracker_type":"keyword","tracker_name":"EndSars","platforms":["twitter"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: micah.walsh@hilllsatterfield.com" \
-H "Authorization: RM21J_FxZksE1Uaxp_8Z" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/plaqad_iq/trackers
POST /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{"tracker":{"tracker_type":"keyword","tracker_name":"EndSars","platforms":["twitter"]}}
| Name | Description |
|---|---|
| tracker[tracker_type] required | Name of tracker |
| tracker[tracker_name] required | Description about tracker |
| tracker[platforms] required | Professionals needed |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "97426c03-6b13-4945-be46-ee12c90fba08",
"type": "plaqad_iq_tracker",
"attributes": {
"tracker_name": "EndSars",
"tracker_type": "keyword",
"platforms": [
"twitter"
],
"status": "active",
"created_by": "Brandon Lowe",
"created_date": "Jun 9, 2021 07:57 AM"
}
}
}
Failure when tracker_type is nil
Request
curl "http://localhost:3000/api/v1/plaqad_iq/trackers" -d '{"tracker":{"tracker_name":"#EndSars","platforms":["twitter","instagram"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ezequiel@greenholt.org" \
-H "Authorization: 3ss3tpj8asamFn6Qv1KR" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/plaqad_iq/trackers
POST /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{"tracker":{"tracker_name":"#EndSars","platforms":["twitter","instagram"]}}
| Name | Description |
|---|---|
| tracker[tracker_type] required | Name of tracker |
| tracker[tracker_name] required | Description about tracker |
| tracker[platforms] required | Professionals needed |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "plaqadiqtracker",
"errors": [
{
"source": {
"pointer": "/data/attributes/tracker_type"
},
"detail": "Tracker_type can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/plaqad_iq/trackers" -d '{"tracker":{"tracker_type":"hashtag","tracker_name":"#EndSars","platforms":["twitter","instagram"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/plaqad_iq/trackers
POST /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{"tracker":{"tracker_type":"hashtag","tracker_name":"#EndSars","platforms":["twitter","instagram"]}}
| Name | Description |
|---|---|
| tracker[tracker_type] required | Name of tracker |
| tracker[tracker_name] required | Description about tracker |
| tracker[platforms] required | Professionals needed |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
PlaqadIq Trackers - Get All
Without params, fetches active hashtags
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: albert.deckow@maggio.com" \
-H "Authorization: e4jSsAEby6itc6Tk1KNt" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers
GET /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "06991059-2804-451c-9717-deef3d5a5582",
"type": "plaqad_iq_tracker",
"attributes": {
"tracker_name": "#OhYesMember",
"tracker_type": "hashtag",
"platforms": [
"instagram",
"twitter",
"youtube"
],
"status": "active",
"created_by": "Adelaide Rippin",
"created_date": "Jun 9, 2021 07:57 AM"
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
With params, fetches active keywords
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: delbert@rolfson.net" \
-H "Authorization: E-fv_kqZed8jTgpfofFz" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers
GET /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "7af7e8bd-10e3-4adb-98c5-017348e46ce7",
"type": "plaqad_iq_tracker",
"attributes": {
"tracker_name": "#OhYesMember",
"tracker_type": "hashtag",
"platforms": [
"instagram",
"twitter",
"youtube"
],
"status": "active",
"created_by": "Mona Renner",
"created_date": "Jun 9, 2021 07:57 AM"
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
With params, fetches paused social accounts
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: corinne@crona.co" \
-H "Authorization: mzRM27vL8VXrF3rGxRWj" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers
GET /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "53852dbc-a962-46fb-8a9c-20f0ea9ea8d9",
"type": "plaqad_iq_tracker",
"attributes": {
"tracker_name": "#OhYesMember",
"tracker_type": "hashtag",
"platforms": [
"instagram",
"twitter",
"youtube"
],
"status": "active",
"created_by": "Opal Daniel",
"created_date": "Jun 9, 2021 07:57 AM"
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers
GET /api/v1/plaqad_iq/trackers
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
PlaqadIq Trackers - Get One
Instagram hashtag tracker flow
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/89077160-427c-4e17-bfb1-3119bf612e1d?platform=instagram" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: vernon.kling@wintheiser.net" \
-H "Authorization: _TyxN-5Y5gzXwVc1Rp1V" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:id
GET /api/v1/plaqad_iq/trackers/89077160-427c-4e17-bfb1-3119bf612e1d?platform=instagram
Accept: application/json
Content-Type: application/json
Parameters
platform: instagram
| Name | Description |
|---|---|
| platform required | platform in lowercase |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6",
"type": "plaqad_iq_instagram_tracker",
"attributes": {
"plaqad_iq_tracker_id": "89077160-427c-4e17-bfb1-3119bf612e1d",
"tracker_name": "#OhYesMember",
"tracker_type": "hashtag",
"tracker_status": "active",
"available_platforms": [
"instagram",
"twitter",
"youtube"
],
"related_hashtags": [
{
"text": "#bluebottle",
"frequency": 2
},
{
"text": "#oceanblue",
"frequency": 1
},
{
"text": "#oceanbluelemonade",
"frequency": 1
},
{
"text": "#lemonade",
"frequency": 1
},
{
"text": "#blue",
"frequency": 1
},
{
"text": "#bluedrink",
"frequency": 1
},
{
"text": "#blueaesthetic",
"frequency": 1
},
{
"text": "#aestheticblue",
"frequency": 1
},
{
"text": "#aesthetic",
"frequency": 1
},
{
"text": "#yellow",
"frequency": 1
}
],
"related_keywords": [
{
"text": "pretty",
"frequency": 1
},
{
"text": "🤷🏻♀️",
"frequency": 1
},
{
"text": "sweet",
"frequency": 1
},
{
"text": "sour!",
"frequency": 1
},
{
"text": "inspired",
"frequency": 1
},
{
"text": "green_toons_",
"frequency": 1
},
{
"text": "brings",
"frequency": 1
},
{
"text": "memories",
"frequency": 1
},
{
"text": "good",
"frequency": 1
},
{
"text": "ole",
"frequency": 1
}
],
"related_urls": {
},
"total_engagement": 130,
"users_count": 4,
"posts_count": 4,
"impressions": 1000,
"sentiments": {
"neutral": 25.0,
"negative": 25.0,
"positive": 50.0
},
"posts_by_date": [
{
"id": "0138c22c-8d6f-47ae-87f3-e65040520e79",
"avatar": null,
"region": null,
"country": null,
"post_id": "17898906232530244",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"username": "Instagram Account",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"post_type": "IMAGE",
"sentiment": "neutral",
"created_at": "2021-06-09T07:58:01.588Z",
"engagement": 2,
"updated_at": "2021-06-09T07:58:01.588Z",
"likes_count": 1,
"views_count": null,
"created_date": "2020-08-11T09:28:40.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"plaqad_iq_influencer_id": "fa145330-030e-446a-9429-97a34f7e4341",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
},
{
"id": "c9ccff14-2470-4f32-ae28-712eb04e350f",
"avatar": null,
"region": null,
"country": null,
"post_id": "18109911793157694",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"username": "Instagram Account",
"post_text": "Sweet sour!",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"created_at": "2021-06-09T07:58:01.617Z",
"engagement": 3,
"updated_at": "2021-06-09T07:58:01.617Z",
"likes_count": 3,
"views_count": null,
"created_date": "2020-08-11T07:53:56.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"plaqad_iq_influencer_id": "d7e78ac7-3f33-4f39-a3da-561e9e19b7f9",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
},
{
"id": "da99901a-88e8-4537-82fb-60856cd3e16d",
"avatar": null,
"region": null,
"country": null,
"post_id": "17866774861955240",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"username": "Instagram Account",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"created_at": "2021-06-09T07:58:01.665Z",
"engagement": 69,
"updated_at": "2021-06-09T07:58:01.665Z",
"likes_count": 65,
"views_count": null,
"created_date": "2020-08-11T07:04:26.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"plaqad_iq_influencer_id": "9c6c9f5f-fb0e-4c5d-b70a-bc059113877a",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
},
{
"id": "b305ad88-1ed7-414b-9eae-c973e8113d6c",
"avatar": null,
"region": null,
"country": null,
"post_id": "18029592184301103",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"username": "Instagram Account",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"created_at": "2021-06-09T07:58:01.679Z",
"engagement": 56,
"updated_at": "2021-06-09T07:58:01.679Z",
"likes_count": 51,
"views_count": null,
"created_date": "2020-08-11T04:29:07.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"plaqad_iq_influencer_id": "00c54228-0184-4e5a-8d8f-b132c9a48cb2",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
}
],
"posts_by_engagement": [
{
"id": "da99901a-88e8-4537-82fb-60856cd3e16d",
"avatar": null,
"region": null,
"country": null,
"post_id": "17866774861955240",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"username": "Instagram Account",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"created_at": "2021-06-09T07:58:01.665Z",
"engagement": 69,
"updated_at": "2021-06-09T07:58:01.665Z",
"likes_count": 65,
"views_count": null,
"created_date": "2020-08-11T07:04:26.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"plaqad_iq_influencer_id": "9c6c9f5f-fb0e-4c5d-b70a-bc059113877a",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
},
{
"id": "b305ad88-1ed7-414b-9eae-c973e8113d6c",
"avatar": null,
"region": null,
"country": null,
"post_id": "18029592184301103",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"username": "Instagram Account",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"created_at": "2021-06-09T07:58:01.679Z",
"engagement": 56,
"updated_at": "2021-06-09T07:58:01.679Z",
"likes_count": 51,
"views_count": null,
"created_date": "2020-08-11T04:29:07.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"plaqad_iq_influencer_id": "00c54228-0184-4e5a-8d8f-b132c9a48cb2",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
},
{
"id": "c9ccff14-2470-4f32-ae28-712eb04e350f",
"avatar": null,
"region": null,
"country": null,
"post_id": "18109911793157694",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"username": "Instagram Account",
"post_text": "Sweet sour!",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"created_at": "2021-06-09T07:58:01.617Z",
"engagement": 3,
"updated_at": "2021-06-09T07:58:01.617Z",
"likes_count": 3,
"views_count": null,
"created_date": "2020-08-11T07:53:56.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"plaqad_iq_influencer_id": "d7e78ac7-3f33-4f39-a3da-561e9e19b7f9",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
},
{
"id": "0138c22c-8d6f-47ae-87f3-e65040520e79",
"avatar": null,
"region": null,
"country": null,
"post_id": "17898906232530244",
"platform": "instagram",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"username": "Instagram Account",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"post_type": "IMAGE",
"sentiment": "neutral",
"created_at": "2021-06-09T07:58:01.588Z",
"engagement": 2,
"updated_at": "2021-06-09T07:58:01.588Z",
"likes_count": 1,
"views_count": null,
"created_date": "2020-08-11T09:28:40.000Z",
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"plaqad_iq_influencer_id": "fa145330-030e-446a-9429-97a34f7e4341",
"plaqad_iq_twitter_tracker_id": null,
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": "6e1fb470-7077-49fe-8c74-9c244a22b0b6"
}
],
"reach": 1000,
"influencers_by_engagement": [
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17866774861955240",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 69,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18029592184301103",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 56,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18109911793157694",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 3,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17898906232530244",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 2,
"profile_image_url": null
}
],
"influencers_by_frequency": [
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17898906232530244",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 2,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18109911793157694",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 3,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "17866774861955240",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 69,
"profile_image_url": null
},
{
"name": "Instagram Account",
"provider": "instagram",
"username": "18029592184301103",
"description": null,
"posts_count": 1,
"followers_count": null,
"total_engagement": 56,
"profile_image_url": null
}
],
"data_processing_completed": true,
"posts_timeline": {
},
"can_download_report": false
}
}
}
Twitter keyword tracker flow
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/6bc61d70-c593-46dc-953e-ab607a4b53d3?platform=twitter" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: cierra@harrismayer.net" \
-H "Authorization: _RL6sixTFPJ3HLHsj392" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:id
GET /api/v1/plaqad_iq/trackers/6bc61d70-c593-46dc-953e-ab607a4b53d3?platform=twitter
Accept: application/json
Content-Type: application/json
Parameters
platform: twitter
| Name | Description |
|---|---|
| platform required | platform in lowercase |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "114dce07-74da-488d-9eef-a902c70b5b05",
"type": "plaqad_iq_twitter_tracker",
"attributes": {
"plaqad_iq_tracker_id": "6bc61d70-c593-46dc-953e-ab607a4b53d3",
"tracker_name": "EndSars",
"tracker_type": "keyword",
"tracker_status": "active",
"available_platforms": [
"twitter"
],
"related_hashtags": {
},
"related_keywords": [
{
"text": "full",
"frequency": 1
},
{
"text": "text",
"frequency": 1
}
],
"related_urls": {
},
"total_engagement": 1035,
"users_count": 1,
"posts_count": 1,
"impressions": 4500,
"sentiments": {
"neutral": 100.0
},
"posts_by_date": [
{
"id": "8e5f7e64-eee8-46f4-b4d3-87692bdeba10",
"avatar": "http://pbg.com/profile_img",
"region": null,
"country": null,
"post_id": "244111636544225280",
"platform": "twitter",
"post_url": "http:twitter.com/ki",
"username": "Omenuko Ikemba",
"post_text": "full text",
"post_type": "quote",
"sentiment": "neutral",
"created_at": "2021-06-09T07:58:03.808Z",
"engagement": 1035,
"updated_at": "2021-06-09T07:58:03.843Z",
"likes_count": 909,
"views_count": null,
"created_date": "2021-06-08T07:58:03.834Z",
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"formatted_created_date": "Jun 8, 2021 08:58 AM",
"plaqad_iq_influencer_id": "e39064d3-90ec-4f78-8fa3-a8675051b963",
"plaqad_iq_twitter_tracker_id": "114dce07-74da-488d-9eef-a902c70b5b05",
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": null
}
],
"posts_by_engagement": [
{
"id": "8e5f7e64-eee8-46f4-b4d3-87692bdeba10",
"avatar": "http://pbg.com/profile_img",
"region": null,
"country": null,
"post_id": "244111636544225280",
"platform": "twitter",
"post_url": "http:twitter.com/ki",
"username": "Omenuko Ikemba",
"post_text": "full text",
"post_type": "quote",
"sentiment": "neutral",
"created_at": "2021-06-09T07:58:03.808Z",
"engagement": 1035,
"updated_at": "2021-06-09T07:58:03.843Z",
"likes_count": 909,
"views_count": null,
"created_date": "2021-06-08T07:58:03.834Z",
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"formatted_created_date": "Jun 8, 2021 08:58 AM",
"plaqad_iq_influencer_id": "e39064d3-90ec-4f78-8fa3-a8675051b963",
"plaqad_iq_twitter_tracker_id": "114dce07-74da-488d-9eef-a902c70b5b05",
"plaqad_iq_youtube_tracker_id": null,
"plaqad_iq_instagram_tracker_id": null
}
],
"reach": 4500,
"influencers_by_engagement": [
{
"name": "Omenuko Ikemba",
"provider": "twitter",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"posts_count": 1,
"followers_count": 9000,
"total_engagement": 1035,
"profile_image_url": "http://pbg.com/profile_img"
}
],
"influencers_by_frequency": [
{
"name": "Omenuko Ikemba",
"provider": "twitter",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"posts_count": 1,
"followers_count": 9000,
"total_engagement": 1035,
"profile_image_url": "http://pbg.com/profile_img"
}
],
"data_processing_completed": true,
"device_sources": [
{
"text": "iPhone",
"percentage": 100.0
}
],
"post_type_breakdown": [
{
"text": "quote",
"percentage": 100.0
}
],
"posts_timeline": {
"08/06/2021": 3
},
"can_download_report": false
}
}
}
Youtube social account flow
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/a3ea063c-d853-4c9b-b516-3272c0512edd?platform=youtube" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: karole@brakusframi.info" \
-H "Authorization: yXxsXpfdjhomjyTcMQ_Z" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:id
GET /api/v1/plaqad_iq/trackers/a3ea063c-d853-4c9b-b516-3272c0512edd?platform=youtube
Accept: application/json
Content-Type: application/json
Parameters
platform: youtube
| Name | Description |
|---|---|
| platform required | platform in lowercase |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "04c38bb3-dd1b-499b-a3cc-9745ee9b1ba6",
"type": "account_tracker",
"attributes": {
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"provider_identifier": "omeni",
"provider": "youtube",
"verified": false,
"description": "",
"data_processing_completed": true,
"profile_image": "http://pbgyu.com/profile_img",
"request_currency": "USD",
"metrics": {
"reach": null,
"impressions": 2900000,
"views_count": 2031297,
"likes_count": 30300,
"quotes_count": null,
"comments_count": 23700,
"dislikes_count": 300,
"followers_count": 9000,
"following_count": 700,
"total_posts_count": 3,
"audience_sentiment": {
"neutral": 66.66666666666666,
"positive": 33.33333333333333
},
"avg_views_per_post": 0.0,
"avg_likes_per_post": 0.01,
"avg_shares_per_post": null,
"avg_engagement_rate": 7723.32,
"avg_retweets_per_post": null,
"avg_comments_per_post": 0.01,
"posts_processed_count": 3,
"retweeted_posts_count": null,
"posts_to_retweets_ratio": null,
"original_post_shares_count": null,
"post_timeline": "June 07, 2021"
},
"posts": [
{
"id": "vYilNc",
"title": "Song by them",
"created_at": "2021-06-07T08:58:04.344+01:00",
"embed_html": "https://www.youtube.com/embed/vYilNc",
"engagement": 695199,
"likes_count": 10100,
"views_count": 677099,
"comments_count": 7900,
"dislikes_count": 100
},
{
"id": "vYilNc",
"title": "Song by them",
"created_at": "2021-06-07T08:58:04.344+01:00",
"embed_html": "https://www.youtube.com/embed/vYilNc",
"engagement": 695199,
"likes_count": 10100,
"views_count": 677099,
"comments_count": 7900,
"dislikes_count": 100
},
{
"id": "vYilNc",
"title": "Song by them",
"created_at": "2021-06-07T08:58:04.344+01:00",
"embed_html": "https://www.youtube.com/embed/vYilNc",
"engagement": 695199,
"likes_count": 10100,
"views_count": 677099,
"comments_count": 7900,
"dislikes_count": 100
}
],
"followers": [
],
"account_growth": {
"09/06/2021": {
"followers": 9000,
"following": 700,
"total_posts": 3
}
},
"country_interaction": {
},
"gender_interaction": {
},
"professional_details": null,
"plaqad_iq_details": {
"tracker_id": "a3ea063c-d853-4c9b-b516-3272c0512edd",
"tracker_name": "omeni",
"tracker_type": "social_account",
"tracker_status": "paused",
"platform": "youtube"
}
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/2d496c81-dae6-4a77-a63a-4ff734f5c178" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:id
GET /api/v1/plaqad_iq/trackers/2d496c81-dae6-4a77-a63a-4ff734f5c178
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| platform required | platform in lowercase |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When tracker_id is not available
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tommy_kemmer@johns.name" \
-H "Authorization: YzFs8yRzpXiRCMGxSZg8" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:id
GET /api/v1/plaqad_iq/trackers/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| platform required | platform in lowercase |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
PlaqadIq Trackers - Influencers
Twitter Flow - Successful with valid params
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/db506ff9-fe76-423f-a0f7-c8735d938980/influencers?platform=twitter&sort_term=eng_desc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: mechelle@hyattwilliamson.info" \
-H "Authorization: QwuazAbBrboKXpWpaKuW" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/influencers
GET /api/v1/plaqad_iq/trackers/db506ff9-fe76-423f-a0f7-c8735d938980/influencers?platform=twitter&sort_term=eng_desc
Accept: application/json
Content-Type: application/json
Parameters
platform: twitter
sort_term: eng_desc
| Name | Description |
|---|---|
| platform required | platform in lowercase |
| sort_term | influencers by engagements,impressions or reach |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "0dce3e1a-e277-4ca9-98c4-7470f82b17c3",
"type": "plaqad_iq_influencer",
"attributes": {
"provider": "twitter",
"username": "Omeni",
"name": "Omenuko Ikemba",
"profile_image_url": "http://pbg.com/profile_img",
"description": "Planning, Executing, Delivery",
"location": "Kite",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 1035,
"impressions": 4500.0,
"reach": 4500.0,
"posts": {
"data": [
{
"id": "b19bf924-cd2d-460e-a4f1-350a10316014",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "0dce3e1a-e277-4ca9-98c4-7470f82b17c3",
"post_id": "244111636544225280",
"formatted_created_date": "Jun 8, 2021 08:58 AM",
"post_text": "full text",
"created_date": "2021-06-08T07:58:08.898Z",
"post_url": "http:twitter.com/ki",
"post_type": "quote",
"sentiment": "neutral",
"likes_count": 909,
"views_count": null,
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"engagement": 1035,
"platform": "twitter",
"influencer": {
"provider": "twitter",
"name": "Omenuko Ikemba",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"profile_image_url": "http://pbg.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 1035
}
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Instagram Flow - Successful with valid params
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/31991add-4a2e-4762-b468-5174365d92df/influencers?platform=instagram&sort_term=reach_asc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tory@rohan.info" \
-H "Authorization: b6Z5trTBx1-6yHyurTGN" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/influencers
GET /api/v1/plaqad_iq/trackers/31991add-4a2e-4762-b468-5174365d92df/influencers?platform=instagram&sort_term=reach_asc
Accept: application/json
Content-Type: application/json
Parameters
platform: instagram
sort_term: reach_asc
| Name | Description |
|---|---|
| platform required | platform in lowercase |
| sort_term | influencers by engagements,impressions or reach |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "251ab776-faa5-4e47-b709-ef0a8ed93893",
"type": "plaqad_iq_influencer",
"attributes": {
"provider": "instagram",
"username": "17898906232530244",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 2,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "38aba5ab-ac70-4325-b53b-b0301f94847d",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "251ab776-faa5-4e47-b709-ef0a8ed93893",
"post_id": "17898906232530244",
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"created_date": "2020-08-11T09:28:40.000Z",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"post_type": "IMAGE",
"sentiment": "neutral",
"likes_count": 1,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 2,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17898906232530244",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 2
}
}
}
]
}
}
},
{
"id": "6139ed17-cb6f-4e91-aa7a-ce0344f6ad09",
"type": "plaqad_iq_influencer",
"attributes": {
"provider": "instagram",
"username": "18109911793157694",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 3,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "7cf917df-d8c7-41c0-96a9-d57bb3a75949",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "6139ed17-cb6f-4e91-aa7a-ce0344f6ad09",
"post_id": "18109911793157694",
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"post_text": "Sweet sour!",
"created_date": "2020-08-11T07:53:56.000Z",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"likes_count": 3,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 3,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18109911793157694",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 3
}
}
}
]
}
}
},
{
"id": "17971251-30a9-4433-8ae4-910d2b7715e6",
"type": "plaqad_iq_influencer",
"attributes": {
"provider": "instagram",
"username": "17866774861955240",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 69,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "4c40d519-5aaf-49a6-ac46-8f42d7c6a109",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "17971251-30a9-4433-8ae4-910d2b7715e6",
"post_id": "17866774861955240",
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"created_date": "2020-08-11T07:04:26.000Z",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 65,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 69,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17866774861955240",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 69
}
}
}
]
}
}
},
{
"id": "796887fd-8dfd-4ea0-8531-4a147d494cb9",
"type": "plaqad_iq_influencer",
"attributes": {
"provider": "instagram",
"username": "18029592184301103",
"name": "Instagram Account",
"profile_image_url": null,
"description": null,
"location": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 56,
"impressions": 250.0,
"reach": 250.0,
"posts": {
"data": [
{
"id": "66b1e481-c9de-47fc-bf25-6c987b752b7c",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "796887fd-8dfd-4ea0-8531-4a147d494cb9",
"post_id": "18029592184301103",
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"created_date": "2020-08-11T04:29:07.000Z",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 51,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 56,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18029592184301103",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 56
}
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Youtube Flow - Successful with valid params
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/0260c2d4-50c5-4473-b666-3cbc372e786d/influencers?platform=youtube&sort_term=imp_desc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lavon@larsonpurdy.name" \
-H "Authorization: JCcGswJ6FWZx1a4PDnn-" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/influencers
GET /api/v1/plaqad_iq/trackers/0260c2d4-50c5-4473-b666-3cbc372e786d/influencers?platform=youtube&sort_term=imp_desc
Accept: application/json
Content-Type: application/json
Parameters
platform: youtube
sort_term: imp_desc
| Name | Description |
|---|---|
| platform required | platform in lowercase |
| sort_term | influencers by engagements,impressions or reach |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "98d09051-4e40-4b0d-8b14-4d9f8aa793c5",
"type": "plaqad_iq_influencer",
"attributes": {
"provider": "youtube",
"username": "UcGQ00Rvc",
"name": "Odinma Umah",
"profile_image_url": "http://pbgyu.com/profile_img",
"description": "",
"location": null,
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199,
"impressions": 4500.0,
"reach": 4500.0,
"posts": {
"data": [
{
"id": "dc6c7396-e55a-4856-9c43-d7a6370659ca",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "98d09051-4e40-4b0d-8b14-4d9f8aa793c5",
"post_id": "vYilNc",
"formatted_created_date": "Jun 7, 2021 08:58 AM",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"created_date": "2021-06-07T07:58:10.242Z",
"post_url": "https://www.youtube.com/embed/vYilNc",
"post_type": "video",
"sentiment": "neutral",
"likes_count": 10100,
"views_count": 677099,
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"engagement": 695199,
"platform": "youtube",
"influencer": {
"provider": "youtube",
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"description": "",
"profile_image_url": "http://pbgyu.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199
}
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
PlaqadIq Trackers - Posts
Twitter Flow - Successful with filters
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/c1a6d12d-f59e-4b9f-a174-4c8c5fd751b2/posts?start_date=2021-06-07&end_date=2021-06-14&platform=twitter&sort_by=desc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: beverlee@lemkeritchie.org" \
-H "Authorization: yWztCtz__XzXvUxDAzbs" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/posts
GET /api/v1/plaqad_iq/trackers/c1a6d12d-f59e-4b9f-a174-4c8c5fd751b2/posts?start_date=2021-06-07&end_date=2021-06-14&platform=twitter&sort_by=desc
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
platform: twitter
sort_by: desc
| Name | Description |
|---|---|
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| platform required | platform in lowercase |
| sort_by | Posts Engagement sort by most or least |
| sentiment_filter | To filter sentiment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "df0b0158-7e96-411b-b859-2bc7cfb82fbd",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "14dfea3a-63c6-49b0-9047-0def1898d9fb",
"post_id": "244111636544225280",
"formatted_created_date": "Jun 8, 2021 08:58 AM",
"post_text": "full text",
"created_date": "2021-06-08T07:58:11.493Z",
"post_url": "http:twitter.com/ki",
"post_type": "quote",
"sentiment": "neutral",
"likes_count": 909,
"views_count": null,
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"engagement": 1035,
"platform": "twitter",
"influencer": {
"provider": "twitter",
"name": "Omenuko Ikemba",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"profile_image_url": "http://pbg.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 1035
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Twitter Flow - Successful with filters
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/4740d56b-925f-4031-8466-d796cfeec983/posts?start_date=2021-06-07&end_date=2021-06-14&platform=twitter&sentiment_filter=neutral" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: dorris@jaskolski.name" \
-H "Authorization: gperaJLLo_76zcvuyK6s" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/posts
GET /api/v1/plaqad_iq/trackers/4740d56b-925f-4031-8466-d796cfeec983/posts?start_date=2021-06-07&end_date=2021-06-14&platform=twitter&sentiment_filter=neutral
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
platform: twitter
sentiment_filter: neutral
| Name | Description |
|---|---|
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| platform required | platform in lowercase |
| sort_by | Posts Engagement sort by most or least |
| sentiment_filter | To filter sentiment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "ffeb9721-d7c8-49f1-93c2-d43bb68592fc",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "c2fd573b-1f22-4aef-9daf-61baa77dddc8",
"post_id": "244111636544225280",
"formatted_created_date": "Jun 8, 2021 08:58 AM",
"post_text": "full text",
"created_date": "2021-06-08T07:58:12.481Z",
"post_url": "http:twitter.com/ki",
"post_type": "quote",
"sentiment": "neutral",
"likes_count": 909,
"views_count": null,
"quotes_count": 0,
"device_or_app": "<a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>",
"comments_count": 124,
"dislikes_count": null,
"original_shares_count": 2,
"engagement": 1035,
"platform": "twitter",
"influencer": {
"provider": "twitter",
"name": "Omenuko Ikemba",
"username": "Omeni",
"description": "Planning, Executing, Delivery",
"profile_image_url": "http://pbg.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 1035
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Twitter Flow - Successful with filters
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/33d62a83-f824-4290-8b84-46c70170d038/posts?start_date=2021-06-07&end_date=2021-06-14&platform=twitter&sentiment_filter=positive" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: sydney_hirthe@baumbach.info" \
-H "Authorization: 979zsmCqAjiivEiukGiF" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/posts
GET /api/v1/plaqad_iq/trackers/33d62a83-f824-4290-8b84-46c70170d038/posts?start_date=2021-06-07&end_date=2021-06-14&platform=twitter&sentiment_filter=positive
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
platform: twitter
sentiment_filter: positive
| Name | Description |
|---|---|
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| platform required | platform in lowercase |
| sort_by | Posts Engagement sort by most or least |
| sentiment_filter | To filter sentiment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 0,
"total_count": 0
}
}
}
Instagram Flow - Successful with filters
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/08bc2602-f528-4d64-a72d-b59658662989/posts?start_date=2020-08-01&end_date=2020-08-14&platform=instagram&sort_by=desc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: velva_lubowitz@watersgaylord.io" \
-H "Authorization: o5xQycrTdJCti-tGcfeh" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/posts
GET /api/v1/plaqad_iq/trackers/08bc2602-f528-4d64-a72d-b59658662989/posts?start_date=2020-08-01&end_date=2020-08-14&platform=instagram&sort_by=desc
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2020-08-01
end_date: 2020-08-14
platform: instagram
sort_by: desc
| Name | Description |
|---|---|
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| platform required | platform in lowercase |
| sort_by | Posts Engagement sort by most or least |
| sentiment_filter | To filter sentiment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "1eea32f0-d3a5-469e-be00-dda8fdbbf518",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "4ea97ceb-173c-4cbf-a94e-4233935fd234",
"post_id": "17866774861955240",
"formatted_created_date": "Aug 11, 2020 07:04 AM",
"post_text": "Inspired from green_toons_ #snowart #kf #liked #inspired #bottleartwork #hisqueenamudha #greentoons #artonhome #artoftheday #bottleart #kingfisher #bluebottle",
"created_date": "2020-08-11T07:04:26.000Z",
"post_url": "https://www.instagram.com/p/CDvW8XGglkh/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 65,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 4,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 69,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17866774861955240",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 69
}
}
},
{
"id": "403b7e18-4a22-47fd-8778-08bcd2c6c142",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "5bd5c8c8-d95b-4f39-8d53-a9287dbafd18",
"post_id": "18029592184301103",
"formatted_created_date": "Aug 11, 2020 04:29 AM",
"post_text": "brings me back the memories of good ole days. Seoul - Palo Alto",
"created_date": "2020-08-11T04:29:07.000Z",
"post_url": "https://www.instagram.com/p/CDvFKuHpeXs/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "positive",
"likes_count": 51,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 5,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 56,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18029592184301103",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 56
}
}
},
{
"id": "dd743bf8-9dbd-405c-86c6-b026cdd770ec",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "e7244d64-4f59-473f-af1c-d2947ce72003",
"post_id": "18109911793157694",
"formatted_created_date": "Aug 11, 2020 07:53 AM",
"post_text": "Sweet sour!",
"created_date": "2020-08-11T07:53:56.000Z",
"post_url": "https://www.instagram.com/p/CDvcm1eps4y/",
"post_type": "CAROUSEL_ALBUM",
"sentiment": "negative",
"likes_count": 3,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 0,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 3,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "18109911793157694",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 3
}
}
},
{
"id": "7fc46d2c-e674-45ff-85ea-6c4103707d7a",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "84d2848d-a0be-4a3a-9432-9cd6863975f4",
"post_id": "17898906232530244",
"formatted_created_date": "Aug 11, 2020 09:28 AM",
"post_text": "It looks pretty 🤷🏻♀️ #calypso #oceanblue #oceanbluelemonade #lemonade #blue #bluedrink #bluebottle #blueaesthetic #aestheticblue #aesthetic #yellow",
"created_date": "2020-08-11T09:28:40.000Z",
"post_url": "https://www.instagram.com/p/CDvnctaBR1r/",
"post_type": "IMAGE",
"sentiment": "neutral",
"likes_count": 1,
"views_count": null,
"quotes_count": null,
"device_or_app": null,
"comments_count": 1,
"dislikes_count": null,
"original_shares_count": null,
"engagement": 2,
"platform": "instagram",
"influencer": {
"provider": "instagram",
"name": "Instagram Account",
"username": "17898906232530244",
"description": null,
"profile_image_url": null,
"followers_count": null,
"posts_count": 1,
"total_engagement": 2
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
}
}
Youtube Flow - Successful with filters
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/10914670-3b06-4bb1-9164-9f2e882f88de/posts?start_date=2021-06-07&end_date=2021-06-14&platform=youtube&sort_by=asc" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: shizue_cain@lubowitz.biz" \
-H "Authorization: a7CjG8YRNh9uyFxnugs8" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/:tracker_id/posts
GET /api/v1/plaqad_iq/trackers/10914670-3b06-4bb1-9164-9f2e882f88de/posts?start_date=2021-06-07&end_date=2021-06-14&platform=youtube&sort_by=asc
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-07
end_date: 2021-06-14
platform: youtube
sort_by: asc
| Name | Description |
|---|---|
| start_date | Start date to fetch posts |
| end_date | End date to fetch posts |
| platform required | platform in lowercase |
| sort_by | Posts Engagement sort by most or least |
| sentiment_filter | To filter sentiment |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "0f025c0e-0151-4484-a809-1b0f1906354e",
"type": "plaqad_iq_post",
"attributes": {
"plaqad_iq_influencer_id": "2458252b-caf8-4b08-8c4a-cf2fabc5ff7c",
"post_id": "vYilNc",
"formatted_created_date": "Jun 7, 2021 08:58 AM",
"post_text": "Song by them - Vote @julie #GoJulie #Julie4President",
"created_date": "2021-06-07T07:58:14.669Z",
"post_url": "https://www.youtube.com/embed/vYilNc",
"post_type": "video",
"sentiment": "neutral",
"likes_count": 10100,
"views_count": 677099,
"quotes_count": null,
"device_or_app": null,
"comments_count": 7900,
"dislikes_count": 100,
"original_shares_count": null,
"engagement": 695199,
"platform": "youtube",
"influencer": {
"provider": "youtube",
"name": "Odinma Umah",
"username": "UcGQ00Rvc",
"description": "",
"profile_image_url": "http://pbgyu.com/profile_img",
"followers_count": 9000,
"posts_count": 1,
"total_engagement": 695199
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
PlaqadIq - Start Tracker
Sets tracker to active if paused
Request
curl "http://localhost:3000/api/v1/plaqad_iq/trackers/aec41e90-fcc4-432b-b9fa-4a6264111d19/start" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: hugh@torphy.org" \
-H "Authorization: euMUpwoNMzEWyFbyoDPv" \
-H "Host: example.org" \
-H "Cookie: "
curl "http://localhost:3000/api/v1/plaqad_iq/trackers/aec41e90-fcc4-432b-b9fa-4a6264111d19/start" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: hugh@torphy.org" \
-H "Authorization: euMUpwoNMzEWyFbyoDPv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/plaqad_iq/trackers/:tracker_id/start
PATCH /api/v1/plaqad_iq/trackers/aec41e90-fcc4-432b-b9fa-4a6264111d19/start
Accept: application/json
Content-Type: application/json
PATCH /api/v1/plaqad_iq/trackers/aec41e90-fcc4-432b-b9fa-4a6264111d19/start
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
{}
None known.
Response
Content-Type: application/json
200 OK
PlaqadIq - Pause Tracker
Sets tracker to paused if active
Request
curl "http://localhost:3000/api/v1/plaqad_iq/trackers/3e758779-6261-46d9-971c-6aade30c48a6/pause" -d '{}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jane_nikolaus@wolff.biz" \
-H "Authorization: XYaXPi2hzScPw31Gv8sF" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/plaqad_iq/trackers/:tracker_id/pause
PATCH /api/v1/plaqad_iq/trackers/3e758779-6261-46d9-971c-6aade30c48a6/pause
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
PlaqadIq - Paywall
Returns paywall for business
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/paywall" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: william@heller.io" \
-H "Authorization: emgmUzmtmHyVxv3H6NJF" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/paywall
GET /api/v1/plaqad_iq/trackers/paywall
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"limit_reached_for_hashtag_keyword": false,
"limit_reached_for_social_account": false,
"limit_reached_for_posts": false,
"hashtag_or_keyword": "1 / 5",
"social_account": "0 / 5",
"posts_monthly_usage": {
"post_count": 6,
"total": 6000,
"total_left": 5994,
"extra_left": 0,
"subcription_left": 5994
},
"has_no_plaqad_iq_subscription": true
}
}
Business Without an active plaqad iq plan
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/paywall" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jutta_greenfelder@champlinhansen.com" \
-H "Authorization: TJbmYmT_FUgsUsWjy27k" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/paywall
GET /api/v1/plaqad_iq/trackers/paywall
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"limit_reached_for_hashtag_keyword": true,
"limit_reached_for_social_account": true,
"limit_reached_for_posts": true,
"hashtag_or_keyword": "0 / 0",
"social_account": "0 / 0",
"posts_monthly_usage": {
"post_count": 0,
"total": 0,
"total_left": 0,
"extra_left": 0,
"subcription_left": 0
},
"has_no_plaqad_iq_subscription": true
}
}
Business with mid month expired plaqad iq plan
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/paywall" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: louis@parisian.biz" \
-H "Authorization: U7T5f9hB9qJG3hvnYQhM" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/paywall
GET /api/v1/plaqad_iq/trackers/paywall
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"limit_reached_for_hashtag_keyword": true,
"limit_reached_for_social_account": true,
"limit_reached_for_posts": true,
"hashtag_or_keyword": "1 / 0",
"social_account": "0 / 0",
"posts_monthly_usage": {
"post_count": 0,
"total": 0,
"total_left": 0,
"extra_left": 0,
"subcription_left": 0
},
"has_no_plaqad_iq_subscription": true
}
}
Professional without an active plaqad iq plan
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/paywall" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: toya.kerluke@nitzsche.io" \
-H "Authorization: CKNbkvvJfXMpvedWwFWg" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/paywall
GET /api/v1/plaqad_iq/trackers/paywall
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"limit_reached_for_hashtag_keyword": true,
"limit_reached_for_social_account": true,
"limit_reached_for_posts": true,
"hashtag_or_keyword": "1 / 0",
"social_account": "0 / 0",
"posts_monthly_usage": {
"post_count": 0,
"total": 0,
"total_left": 0,
"extra_left": 0,
"subcription_left": 0
},
"has_no_plaqad_iq_subscription": true
}
}
Professional with mid month expired plaqad iq plan
Request
curl -g "http://localhost:3000/api/v1/plaqad_iq/trackers/paywall" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: rickey@kertzmann.info" \
-H "Authorization: gKxXKJazg6vstBKoevBz" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/plaqad_iq/trackers/paywall
GET /api/v1/plaqad_iq/trackers/paywall
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"limit_reached_for_hashtag_keyword": true,
"limit_reached_for_social_account": true,
"limit_reached_for_posts": true,
"hashtag_or_keyword": "0 / 0",
"social_account": "0 / 0",
"posts_monthly_usage": {
"post_count": 0,
"total": 0,
"total_left": 0,
"extra_left": 0,
"subcription_left": 0
},
"has_no_plaqad_iq_subscription": true
}
}
PlaqadIq - Delete Tracker
Deletes a tracker
Request
curl "http://localhost:3000/api/v1/plaqad_iq/trackers/d9fd81b0-0528-4077-8228-323ba7912e90" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: shirl_bauch@ryanbreitenberg.co" \
-H "Authorization: ywj6Eh6j5FyZfiVC4we7" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/plaqad_iq/trackers/:id
DELETE /api/v1/plaqad_iq/trackers/d9fd81b0-0528-4077-8228-323ba7912e90
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json
200 OK
Portfolio - Create Accounts
Successful with with images
Request
curl "http://localhost:3000/api/v1/professionals/cb78d565-bafc-4b53-b6e8-7617e3a5ead8/portfolios" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[professional_id]"
cb78d565-bafc-4b53-b6e8-7617e3a5ead8
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[description]"
Et non omnis. Ex ducimus maxime. Tempore quae fugit.
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[publication_type]"
Article
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[tags][]"
Writing
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[tags][]"
Proof-reading
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: patrica@wisozk.com" \
-H "Authorization: rRLRSJzovdjCjh8JbH5s" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/portfolios
POST /api/v1/professionals/cb78d565-bafc-4b53-b6e8-7617e3a5ead8/portfolios
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[professional_id]"
cb78d565-bafc-4b53-b6e8-7617e3a5ead8
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[description]"
Et non omnis. Ex ducimus maxime. Tempore quae fugit.
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[publication_type]"
Article
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[tags][]"
Writing
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[tags][]"
Proof-reading
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| portfolio[professional_id] required | ID of associated professional |
| portfolio[title] | Name of creator's project |
| portfolio[description] required | About the portfolio |
| portfolio[publication_type] | Type of publication |
| portfolio[link] | Link to the potfolio |
| portfolio[completed_at] | Date the potfolio was completed |
| portfolio[documents] required | Image/file representation of the potfolio |
| portfolio[tags] | Tags for publishers |
| portfolio[services] | Services for creators |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "56910a1e-3bdf-4710-bec9-ce20b7e36fda",
"type": "portfolio",
"attributes": {
"professional_id": "cb78d565-bafc-4b53-b6e8-7617e3a5ead8",
"title": null,
"description": "Et non omnis. Ex ducimus maxime. Tempore quae fugit.",
"publication_type": "Article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": null,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs0T1RWa01EVmhaUzAxTWpnMExUUTJZekV0T1dWaE5pMWtZbUptWmpGaFptTXhaVE1HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--ee51f3c54ef429f8e62665e8cc94bff605600261/fruits.jpeg"
},
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1WlRNNE9EUm1NaTAwT1RVM0xUUmlabU10T1Raa1pTMHhPRFJqTVdJek4yWTVNbVlHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--d9293519927a64212d23bf790a0394e4984110b2/doc.pdf"
}
],
"published_at": "June, 2021"
}
}
}
Successful with with images
Request
curl "http://localhost:3000/api/v1/professionals/889d2575-1bf6-41ce-96eb-0d1ebd73a69b/portfolios" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[professional_id]"
889d2575-1bf6-41ce-96eb-0d1ebd73a69b
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[title]"
Afrima Logo Designs
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[description]"
Quia et perspiciatis. Distinctio fuga autem. Molestias dicta illum.
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[services][]"
Graphic-Designs
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[services][]"
Photoshop
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: morgan_jacobson@harbermohr.biz" \
-H "Authorization: yFJ_3sXga2YG5UTsTRV2" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/portfolios
POST /api/v1/professionals/889d2575-1bf6-41ce-96eb-0d1ebd73a69b/portfolios
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[professional_id]"
889d2575-1bf6-41ce-96eb-0d1ebd73a69b
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[title]"
Afrima Logo Designs
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[description]"
Quia et perspiciatis. Distinctio fuga autem. Molestias dicta illum.
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[services][]"
Graphic-Designs
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[services][]"
Photoshop
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="portfolio[documents][]"; filename="doc.pdf"
Content-Type:
Content-Length: 12781
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| portfolio[professional_id] required | ID of associated professional |
| portfolio[title] | Name of creator's project |
| portfolio[description] required | About the portfolio |
| portfolio[publication_type] | Type of publication |
| portfolio[link] | Link to the potfolio |
| portfolio[completed_at] | Date the potfolio was completed |
| portfolio[documents] required | Image/file representation of the potfolio |
| portfolio[tags] | Tags for publishers |
| portfolio[services] | Services for creators |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "47cbca61-3bf1-49fb-ba28-c28dd4fde329",
"type": "portfolio",
"attributes": {
"professional_id": "889d2575-1bf6-41ce-96eb-0d1ebd73a69b",
"title": "Afrima Logo Designs",
"description": "Quia et perspiciatis. Distinctio fuga autem. Molestias dicta illum.",
"publication_type": null,
"link": null,
"tags": [
],
"services": [
"Graphic-Designs",
"Photoshop"
],
"completed_at": null,
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6WlRaall6TmxZaTAyWXpOaUxUUXpPREV0T1dKaU5TMW1aRGxtTldKa01UQmlOelFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--d4561f3e085936e1a46c59fffb43cacf97e631a9/fruits.jpeg"
},
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt3TVdWaE9ESTFOaTB3TVdRMkxUUXlOamt0T1RKaU1pMDNZekJoTURJNE5XSTNNakVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--47108d8ba44bbce990aecec0e69cc4caf218dc94/doc.pdf"
}
],
"published_at": "June, 2021"
}
}
}
Failure with with invalid params
Request
curl "http://localhost:3000/api/v1/professionals/e4c27bf4-d26e-42c1-9f30-272c229f8fa0/portfolios" -d '{"portfolio":{"professional_id":"e4c27bf4-d26e-42c1-9f30-272c229f8fa0","description":"","publication_type":"Article","tags":["Advert"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: selena_paucek@tromp.com" \
-H "Authorization: zF_JcxvA_1k4N_miiZdv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/portfolios
POST /api/v1/professionals/e4c27bf4-d26e-42c1-9f30-272c229f8fa0/portfolios
Accept: application/json
Content-Type: application/json
Parameters
{"portfolio":{"professional_id":"e4c27bf4-d26e-42c1-9f30-272c229f8fa0","description":"","publication_type":"Article","tags":["Advert"]}}
| Name | Description |
|---|---|
| portfolio[professional_id] required | ID of associated professional |
| portfolio[title] | Name of creator's project |
| portfolio[description] required | About the portfolio |
| portfolio[publication_type] | Type of publication |
| portfolio[link] | Link to the potfolio |
| portfolio[completed_at] | Date the potfolio was completed |
| portfolio[documents] required | Image/file representation of the potfolio |
| portfolio[tags] | Tags for publishers |
| portfolio[services] | Services for creators |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "portfolio",
"errors": [
{
"source": {
"pointer": "/data/attributes/description"
},
"detail": "Description can't be blank",
"title": "can't be blank"
},
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base Link and documents cannot be blank.",
"title": "Link and documents cannot be blank."
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/professionals/ed91def1-7613-4804-866b-6107b2e08aee/portfolios" -d '{"portfolio":{"professional_id":"ed91def1-7613-4804-866b-6107b2e08aee","description":"Something about Ebola","publication_type":"Article","tags":["advert"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/portfolios
POST /api/v1/professionals/ed91def1-7613-4804-866b-6107b2e08aee/portfolios
Accept: application/json
Content-Type: application/json
Parameters
{"portfolio":{"professional_id":"ed91def1-7613-4804-866b-6107b2e08aee","description":"Something about Ebola","publication_type":"Article","tags":["advert"]}}
| Name | Description |
|---|---|
| portfolio[professional_id] required | ID of associated professional |
| portfolio[title] | Name of creator's project |
| portfolio[description] required | About the portfolio |
| portfolio[publication_type] | Type of publication |
| portfolio[link] | Link to the potfolio |
| portfolio[completed_at] | Date the potfolio was completed |
| portfolio[documents] required | Image/file representation of the potfolio |
| portfolio[tags] | Tags for publishers |
| portfolio[services] | Services for creators |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Portfolios - Get All
Getting a list of portfolios
Request
curl -g "http://localhost:3000/api/v1/professionals/f009795b-9529-4b7c-a554-5da7965047f5/portfolios" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: porsche@bergstrom.org" \
-H "Authorization: k43d_oyGurqdWFSqmJun" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/portfolios
GET /api/v1/professionals/f009795b-9529-4b7c-a554-5da7965047f5/portfolios
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "2c0e48c0-3b98-414e-8301-57e14589e7e2",
"type": "portfolio",
"attributes": {
"professional_id": "f009795b-9529-4b7c-a554-5da7965047f5",
"title": null,
"description": "Et repellendus voluptatem. Blanditiis aut natus. Autem error aut.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxsTWpRNFlXWXdZeTFoTXprd0xUUmtOREF0WVdGbVlpMHhZelV3TldOaE56VmxOekVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--55a68d21413433e7b2c7ef755ad8dfd732b97cc9/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
},
{
"id": "f7c4453b-a2dd-4def-8af1-3441934a266b",
"type": "portfolio",
"attributes": {
"professional_id": "f009795b-9529-4b7c-a554-5da7965047f5",
"title": null,
"description": "Enim sint dolorem. Blanditiis enim voluptatem. Aliquam voluptatem voluptatibus.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtTURCbFpEbGtaUzA1WVRnMkxUUmhaR1F0WVdWbVpDMDVZemRoTW1ZME0yRTNNVFVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--0021cf05aec1aaf787e1386e1a315d8ef2a7f0b7/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
},
{
"id": "decbb25d-567c-4611-b85b-5a330a334507",
"type": "portfolio",
"attributes": {
"professional_id": "f009795b-9529-4b7c-a554-5da7965047f5",
"title": null,
"description": "Placeat eius sunt. Adipisci dicta atque. Incidunt est hic.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxpTkdaa1pXRTBNaTB5WlRnNExUUXdNalF0WWpRMFl5MHdOekZpTkdOak1tVmhNakVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--99b8b34502e4c8a26aa24debe65faab8c20dacf8/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/professionals/58e20748-9a11-4958-a490-811bd0356059/portfolios" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/portfolios
GET /api/v1/professionals/58e20748-9a11-4958-a490-811bd0356059/portfolios
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Portfolio - Get One
Getting a Publisher's portfolio
Request
curl -g "http://localhost:3000/api/v1/professionals/0477eefc-60df-4b7a-b293-06ae206c8e17/portfolios/717c068f-d1f9-432d-bf12-b1faa075d18d" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: everette.senger@schneiderabshire.info" \
-H "Authorization: KHP3MsMk8AbyMx6TKNoN" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/portfolios/:id
GET /api/v1/professionals/0477eefc-60df-4b7a-b293-06ae206c8e17/portfolios/717c068f-d1f9-432d-bf12-b1faa075d18d
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "717c068f-d1f9-432d-bf12-b1faa075d18d",
"type": "portfolio",
"attributes": {
"professional_id": "0477eefc-60df-4b7a-b293-06ae206c8e17",
"title": null,
"description": "Unde consequuntur quibusdam. Vel quas velit. Molestiae qui est.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxqWVdWaE1HWXlZUzAxWVdNekxUUXpOVFF0WW1OaU1DMWhZVEEzWmpCbU56VXlNRE1HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--1da0bca11451d9c102c1821b66d700bd654b1bdf/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
}
Getting a Creator's portfolio
Request
curl -g "http://localhost:3000/api/v1/professionals/284af2ba-a079-4a3d-a1b4-0af06bfcd540/portfolios/f3d8092d-7917-473f-b384-26e9cee3f621" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: cortez_mante@cummings.biz" \
-H "Authorization: c6yMkyyWZrc-NeURw5Cc" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/portfolios/:id
GET /api/v1/professionals/284af2ba-a079-4a3d-a1b4-0af06bfcd540/portfolios/f3d8092d-7917-473f-b384-26e9cee3f621
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "f3d8092d-7917-473f-b384-26e9cee3f621",
"type": "portfolio",
"attributes": {
"professional_id": "284af2ba-a079-4a3d-a1b4-0af06bfcd540",
"title": null,
"description": "Itaque in cum. Non consequatur modi. Aut repellat nostrum.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt4TWpVM1pEZGhOUzB6TnpReExUUTNOekl0WWprMll5MDVaalEzTURWbE9EQmhaRGdHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--83e038e1908b6c6604efdc9156462c19eb844db0/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/professionals/c21fb25f-0523-4f14-9d14-443972408c54/portfolios/93b5f2d5-048d-4e9e-824f-c7a9b2ed9822" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/portfolios/:id
GET /api/v1/professionals/c21fb25f-0523-4f14-9d14-443972408c54/portfolios/93b5f2d5-048d-4e9e-824f-c7a9b2ed9822
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/professionals/8f7ab11d-9877-4a8a-8759-51c444c0fab4/portfolios/a" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: frederic@stantondickinson.co" \
-H "Authorization: NT-Vz3yKLj_cZs2Ax8pv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/portfolios/:id
GET /api/v1/professionals/8f7ab11d-9877-4a8a-8759-51c444c0fab4/portfolios/a
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Portfolio - Update
Successful with with valid params
Request
curl "http://localhost:3000/api/v1/professionals/c7644c05-2884-469b-87b5-eb0502ae8466/portfolios/f3273566-f0e2-4523-971a-6c7a4d771c36" -d '{"portfolio":{"professional_id":"c7644c05-2884-469b-87b5-eb0502ae8466","description":"Dolores sapiente ipsam. Sint voluptatem non. Enim aut explicabo.","publication_type":"Tutorial","tags":["Writing","Proof-reading"],"documents":[{"original_filename":"fruits.jpeg","tempfile":"#\u003cFile:0x00007fb75abf7e58\u003e","content_type":null},{"original_filename":"doc.pdf","tempfile":"#\u003cFile:0x00007fb75abf7458\u003e","content_type":null}]}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jayson@reingersteuber.co" \
-H "Authorization: ze5ZFWry5y_uVkzvz-HV" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:professional_id/portfolios/:id
PATCH /api/v1/professionals/c7644c05-2884-469b-87b5-eb0502ae8466/portfolios/f3273566-f0e2-4523-971a-6c7a4d771c36
Accept: application/json
Content-Type: application/json
Parameters
{"portfolio":{"professional_id":"c7644c05-2884-469b-87b5-eb0502ae8466","description":"Dolores sapiente ipsam. Sint voluptatem non. Enim aut explicabo.","publication_type":"Tutorial","tags":["Writing","Proof-reading"],"documents":[{"original_filename":"fruits.jpeg","tempfile":"#\u003cFile:0x00007fb75abf7e58\u003e","content_type":null},{"original_filename":"doc.pdf","tempfile":"#\u003cFile:0x00007fb75abf7458\u003e","content_type":null}]}}
| Name | Description |
|---|---|
| portfolio[professional_id] required | ID of associated professional |
| portfolio[title] | Name of creator's project |
| portfolio[description] required | About the portfolio |
| portfolio[publication_type] | Type of publication |
| portfolio[link] | Link to the potfolio |
| portfolio[completed_at] | Date the potfolio was completed |
| portfolio[documents] required | Image/file representation of the potfolio |
| portfolio[tags] | Tags for publishers |
| portfolio[services] | Services for creators |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "f3273566-f0e2-4523-971a-6c7a4d771c36",
"type": "portfolio",
"attributes": {
"professional_id": "c7644c05-2884-469b-87b5-eb0502ae8466",
"title": null,
"description": "Dolores sapiente ipsam. Sint voluptatem non. Enim aut explicabo.",
"publication_type": "Tutorial",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtT0dWbFltRmhOQzFtTVRRMkxUUTJabVl0WVRkaFl5MHpPVE0zTWpRMVlqRTJZellHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--abf6cc8aa38a8d2c97d3d1f3537e9b0d6f7cb27c/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
}
With another user's portfolio
Request
curl "http://localhost:3000/api/v1/professionals/f2856957-8f59-4847-8ae5-46419dfefc80/portfolios/ad700965-f95e-4a95-88e5-51773b98e8b7" -d '{"portfolio":{"professional_id":"f2856957-8f59-4847-8ae5-46419dfefc80"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: dot@cremin.info" \
-H "Authorization: rxCgUcyhTH_cParmPSPr" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:professional_id/portfolios/:id
PATCH /api/v1/professionals/f2856957-8f59-4847-8ae5-46419dfefc80/portfolios/ad700965-f95e-4a95-88e5-51773b98e8b7
Accept: application/json
Content-Type: application/json
Parameters
{"portfolio":{"professional_id":"f2856957-8f59-4847-8ae5-46419dfefc80"}}
| Name | Description |
|---|---|
| portfolio[professional_id] required | ID of associated professional |
| portfolio[title] | Name of creator's project |
| portfolio[description] required | About the portfolio |
| portfolio[publication_type] | Type of publication |
| portfolio[link] | Link to the potfolio |
| portfolio[completed_at] | Date the potfolio was completed |
| portfolio[documents] required | Image/file representation of the potfolio |
| portfolio[tags] | Tags for publishers |
| portfolio[services] | Services for creators |
Response
204 No Content
With invalid params
Request
curl "http://localhost:3000/api/v1/professionals/8c0938c4-0b13-4539-a4dd-cdc91e635b97/portfolios/ed138cb4-e4e8-418b-a49f-e9b4f7612b7f" -d '{"portfolio":{"professional_id":"8c0938c4-0b13-4539-a4dd-cdc91e635b97","description":""}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: leann@carroll.biz" \
-H "Authorization: ZcSKEXUhD6tdDTkPLxTY" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:professional_id/portfolios/:id
PATCH /api/v1/professionals/8c0938c4-0b13-4539-a4dd-cdc91e635b97/portfolios/ed138cb4-e4e8-418b-a49f-e9b4f7612b7f
Accept: application/json
Content-Type: application/json
Parameters
{"portfolio":{"professional_id":"8c0938c4-0b13-4539-a4dd-cdc91e635b97","description":""}}
| Name | Description |
|---|---|
| portfolio[professional_id] required | ID of associated professional |
| portfolio[title] | Name of creator's project |
| portfolio[description] required | About the portfolio |
| portfolio[publication_type] | Type of publication |
| portfolio[link] | Link to the potfolio |
| portfolio[completed_at] | Date the potfolio was completed |
| portfolio[documents] required | Image/file representation of the potfolio |
| portfolio[tags] | Tags for publishers |
| portfolio[services] | Services for creators |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "ed138cb4-e4e8-418b-a49f-e9b4f7612b7f",
"type": "portfolio",
"errors": [
{
"source": {
"pointer": "/data/attributes/description"
},
"detail": "Description can't be blank",
"title": "can't be blank"
}
]
}
Portfolio - Delete
Successfully deletes a portfolio
Request
curl "http://localhost:3000/api/v1/professionals/737afd91-e21d-4da7-a4df-fe09bea8dc6c/portfolios/de628fc1-eb51-4ab2-b053-2228e94001b4" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: dana_will@spencer.name" \
-H "Authorization: HUs2USzbrYomxdaGGREo" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/portfolios/:id
DELETE /api/v1/professionals/737afd91-e21d-4da7-a4df-fe09bea8dc6c/portfolios/de628fc1-eb51-4ab2-b053-2228e94001b4
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "2222b707-2979-4528-815d-dc6a1c54d786",
"type": "portfolio",
"attributes": {
"professional_id": "737afd91-e21d-4da7-a4df-fe09bea8dc6c",
"title": null,
"description": "Autem nostrum dolores. Architecto voluptatem dolorem. Doloribus voluptatum at.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWsyT1RabU9HUmtNeTA0WlRnNExUUmlNalV0WVRNeU9DMHdPVEl3TXpBNFl6azVOV1FHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--c8470e818a58f715533c3453da6b726de023a917/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
},
{
"id": "a242274b-0764-42db-9040-ad2d73c94276",
"type": "portfolio",
"attributes": {
"professional_id": "737afd91-e21d-4da7-a4df-fe09bea8dc6c",
"title": null,
"description": "Omnis voluptatem doloremque. Dolore numquam quisquam. Debitis vel dolores.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1TW1aaE5qTTNNeTAwWXpnMkxUUTFaVGN0WVRrd1pTMW1aREUzWmpoa1l6ZGhOV1VHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--eda190c2b10fe2e48b1b03dba1a655eaae8eb3eb/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
With another user's portfolio
Request
curl "http://localhost:3000/api/v1/professionals/eb9ddfbb-4b03-4584-899b-8851457cac9c/portfolios/c2ddbac2-e111-464a-9cef-a4d2e40204a4" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: verdie@koepp.net" \
-H "Authorization: Z2BpNXQDWk8QPnrdWTcF" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/portfolios/:id
DELETE /api/v1/professionals/eb9ddfbb-4b03-4584-899b-8851457cac9c/portfolios/c2ddbac2-e111-464a-9cef-a4d2e40204a4
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
204 No Content
Without Authentication
Request
curl "http://localhost:3000/api/v1/professionals/f2fdb41a-434a-4c70-b454-22162f7dedf0/portfolios/17728c58-c16f-45f3-8923-e86ee4f694a9" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/portfolios/:id
DELETE /api/v1/professionals/f2fdb41a-434a-4c70-b454-22162f7dedf0/portfolios/17728c58-c16f-45f3-8923-e86ee4f694a9
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Professional - Create Accounts
Successful publisher with with valid params
Request
curl "http://localhost:3000/api/v1/professionals" -d '{"professional":{"professional_type":"publisher","publication_name":"BellaNaija","services":["press release"],"niche":["advert"]}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: michal@kshlerin.name" \
-H "Authorization: bsSksfJ1eafsFy7F4d3r" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals
POST /api/v1/professionals
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"professional_type":"publisher","publication_name":"BellaNaija","services":["press release"],"niche":["advert"]}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | Publishers/Creators - Available services offered |
| professional[niche] | Publishers/Influencers - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "c96fd0b5-10a1-4c7e-b210-b4e043897fc5",
"type": "authenticated_user",
"attributes": {
"fullname": "Piper Gerhold",
"username": "piper-gerhold-c96fd0b5-10a1-4c7e-b210-b4e043897fc5",
"email": "michal@kshlerin.name",
"firstname": "Piper",
"lastname": "Gerhold",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "bsSksfJ1eafsFy7F4d3r",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": "29f0e770-b4d3-475d-aa05-ec249a23edc2",
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": {
"data": {
"id": "9490f17f-70f5-4f4c-be42-e38aaca0c42a",
"type": "professional",
"attributes": {
"fullname": "Piper Gerhold",
"email": "michal@kshlerin.name",
"bio": null,
"username": "piper-gerhold-c96fd0b5-10a1-4c7e-b210-b4e043897fc5",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"press release"
],
"niche": [
"advert"
],
"platform_bio": null,
"currency": "USD",
"phone_number": null,
"country_code": null,
"tin": null,
"avg_ratings": 0.0,
"publication_website": null,
"publication_name": "BellaNaija",
"charge_from": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"charge_to": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"business": null,
"profile_image_url": ""
}
}
}
Successful creator with with valid params
Request
curl "http://localhost:3000/api/v1/professionals" -d '{"professional":{"professional_type":"creator","services":["press release"],"charge_from":70000,"charge_to":250000}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: frank@hammeswhite.com" \
-H "Authorization: LVhnSnjMwDNfmExDqX3-" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals
POST /api/v1/professionals
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"professional_type":"creator","services":["press release"],"charge_from":70000,"charge_to":250000}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | Publishers/Creators - Available services offered |
| professional[niche] | Publishers/Influencers - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "a017b881-16fd-4025-934c-ab15675835b5",
"type": "authenticated_user",
"attributes": {
"fullname": "Odell Abshire",
"username": "odell-abshire-a017b881-16fd-4025-934c-ab15675835b5",
"email": "frank@hammeswhite.com",
"firstname": "Odell",
"lastname": "Abshire",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "LVhnSnjMwDNfmExDqX3-",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": "7cfb9272-4786-4d65-bfbc-c74900991255",
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": {
"data": {
"id": "7704a830-0999-4295-8732-3ffbd5d72143",
"type": "professional",
"attributes": {
"fullname": "Odell Abshire",
"email": "frank@hammeswhite.com",
"bio": null,
"username": "odell-abshire-a017b881-16fd-4025-934c-ab15675835b5",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"press release"
],
"niche": [
],
"platform_bio": null,
"currency": "USD",
"phone_number": null,
"country_code": null,
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"business": null,
"profile_image_url": ""
}
}
}
Successful influencer with with multiple accounts
Request
curl "http://localhost:3000/api/v1/professionals" -d '{"professional":{"professional_type":"influencer","niche":["Entertainment"],"platform_bio":"Eum autem sapiente. Quo et quia. Quidem doloribus dicta.","locations":["Lagos"],"post_with_photo_fee":5000,"post_with_carousel_fee":7000,"post_with_video_fee":9000,"live_video_fee":15000,"story_fee":10000}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: testuser@twitter.com" \
-H "Authorization: Fw66wQWzZzBsXjbFvyKu" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals
POST /api/v1/professionals
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"professional_type":"influencer","niche":["Entertainment"],"platform_bio":"Eum autem sapiente. Quo et quia. Quidem doloribus dicta.","locations":["Lagos"],"post_with_photo_fee":5000,"post_with_carousel_fee":7000,"post_with_video_fee":9000,"live_video_fee":15000,"story_fee":10000}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | Publishers/Creators - Available services offered |
| professional[niche] | Publishers/Influencers - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "236461dd-dc11-45d2-a37d-4a7b29b40f6a",
"type": "authenticated_user",
"attributes": {
"fullname": "compata",
"username": "compata-236461dd-dc11-45d2-a37d-4a7b29b40f6a",
"email": "testuser@twitter.com",
"firstname": "compata",
"lastname": null,
"bio": "Just a doctor",
"location": null,
"email_status": "confirmed",
"authentication_token": "Fw66wQWzZzBsXjbFvyKu",
"currency": "NGN",
"country_code": null,
"role": null,
"wallet_id": "ccf4578f-a025-4298-bcf3-fe09d21e13b4",
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
{
"twitter": {
"data": {
"provider_identifier": "DoctorJ",
"profile_image": "http://pbg.com/profile_img",
"username": "Omeni",
"name": "Omenuko Ikemba",
"bio": "Planning, Executing, Delivery",
"followers_count": 9000,
"total_posts_count": 3,
"avg_engagement_rate": null,
"post_timeline": null
}
}
},
{
"youtube": {
"data": {
"provider_identifier": "UcGQ00Rvc",
"profile_image": "http://pbgyu.com/profile_img",
"username": "UcGQ00Rvc",
"name": "Odinma Umah",
"bio": "",
"followers_count": 9000,
"total_posts_count": 3,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"professional": {
"data": {
"id": "0c5a0022-7ad7-40ba-a740-581ffade1c76",
"type": "professional",
"attributes": {
"fullname": "compata",
"email": "testuser@twitter.com",
"bio": "Just a doctor",
"username": "compata-236461dd-dc11-45d2-a37d-4a7b29b40f6a",
"profile_image_url": "http://pbg.com/profile_img",
"cover_image_url": "http://pbg.com/profile_img",
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment"
],
"platform_bio": "Eum autem sapiente. Quo et quia. Quidem doloribus dicta.",
"currency": "NGN",
"locations": [
"Lagos"
],
"phone_number": null,
"country_code": null,
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"charge_to": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"business": null,
"profile_image_url": "http://pbg.com/profile_img"
}
}
}
Failure with with invalid params
Request
curl "http://localhost:3000/api/v1/professionals" -d '{"professional":{"professional_type":"","publication_name":"BellaNaija"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: hector@trompbechtelar.io" \
-H "Authorization: BruPUozSsGd8Wh-zzekj" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals
POST /api/v1/professionals
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"professional_type":"","publication_name":"BellaNaija"}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | Publishers/Creators - Available services offered |
| professional[niche] | Publishers/Influencers - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "professional",
"errors": [
{
"source": {
"pointer": "/data/attributes/professional_type"
},
"detail": "Professional_type can't be blank",
"title": "can't be blank"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/professionals" -d '{"professional":{"professional_type":"publisher","publication_name":"BellaNaija"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals
POST /api/v1/professionals
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"professional_type":"publisher","publication_name":"BellaNaija"}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | Publishers/Creators - Available services offered |
| professional[niche] | Publishers/Influencers - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Professional - Get All
Getting all professionals
Request
curl -g "http://localhost:3000/api/v1/professionals" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals
GET /api/v1/professionals
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"publishers": {
"data": [
{
"id": "c33954f5-b8ac-440d-9b52-4fcf82ea2966",
"type": "professional",
"attributes": {
"fullname": "Humberto Witting",
"email": "silas@conn.info",
"bio": null,
"username": "humberto-witting-2047ed08-e1f8-4625-98d6-686cfa791e23",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"platform_bio": "In non consequatur. Suscipit error placeat. Non nisi quia.",
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"publication_website": "ohara.co",
"publication_name": "Ritchie, Bernier and Zulauf",
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
},
{
"id": "05fab2b2-8cea-483b-9534-6730eef877d1",
"type": "professional",
"attributes": {
"fullname": "Sanford Ullrich",
"email": "stewart.kiehn@dubuque.biz",
"bio": null,
"username": "sanford-ullrich-03931453-7b9c-467d-be2a-dd9654dffa37",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"platform_bio": "Quia perferendis labore. Aut molestiae recusandae. Reiciendis quia in.",
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"publication_website": "mosciski.io",
"publication_name": "Smitham, Yundt and Buckridge",
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
]
},
"creators": {
"data": [
{
"id": "036e4f37-3893-4a93-93ca-f126003f183d",
"type": "professional",
"attributes": {
"fullname": "Monty Johnston",
"email": "jacquie.halvorson@gorczany.co",
"bio": null,
"username": "monty-johnston-d6d81e7f-383a-4340-a36f-8988dbd6dfd3",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"platform_bio": null,
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
},
{
"id": "18da9edc-57ee-491a-ba2e-4f25f564e643",
"type": "professional",
"attributes": {
"fullname": "Gino Kuphal",
"email": "fausto_tillman@schulistgaylord.io",
"bio": null,
"username": "gino-kuphal-a7698a00-d37b-4dbb-8b89-f970bee9991b",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"platform_bio": null,
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
]
},
"influencers": {
"data": [
{
"id": "509b6d58-e4a8-4d4c-8b18-757279941d9c",
"type": "professional",
"attributes": {
"fullname": "Quinn Ledner",
"email": "adolfo@feeneyemmerich.io",
"bio": null,
"username": "quinn-ledner-36538f4a-21dd-4bca-b560-a2487f21ca3b",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment"
],
"platform_bio": "Non nostrum consequatur. Quia enim in. Aut maiores ut.",
"currency": "USD",
"locations": [
"Lagos"
],
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$10,000",
"formated_naira_value": "₦4,700,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$5,000",
"formated_naira_value": "₦2,350,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$9,000",
"formated_naira_value": "₦4,230,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$7,000",
"formated_naira_value": "₦3,290,000",
"value": 7000
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
},
{
"id": "39716443-49aa-4eef-b482-a59a885c61ba",
"type": "professional",
"attributes": {
"fullname": "Werner Berge",
"email": "dusti.hand@doyleblanda.io",
"bio": null,
"username": "werner-berge-525b56f3-63b4-4c8e-bf4c-6922e0943d27",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment"
],
"platform_bio": "Enim maxime facere. Vitae odit deserunt. Corrupti nostrum fugit.",
"currency": "USD",
"locations": [
"Lagos"
],
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$10,000",
"formated_naira_value": "₦4,700,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$5,000",
"formated_naira_value": "₦2,350,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$9,000",
"formated_naira_value": "₦4,230,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$7,000",
"formated_naira_value": "₦3,290,000",
"value": 7000
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 6
}
}
}
Professional - Get One
Getting a Publisher
Request
curl -g "http://localhost:3000/api/v1/professionals/ef922018-a26c-4183-85fc-d70d0158b519" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: sanford_orn@weimann.com" \
-H "Authorization: kZTZMs3pbXFWzfHrGdA4" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:id
GET /api/v1/professionals/ef922018-a26c-4183-85fc-d70d0158b519
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "ef922018-a26c-4183-85fc-d70d0158b519",
"type": "professional",
"attributes": {
"fullname": "Lelah Pouros",
"email": "sanford_orn@weimann.com",
"bio": null,
"username": "lelah-pouros-e7d71818-8361-4e08-94f0-489524b78978",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"platform_bio": "Voluptas et dignissimos. Qui esse placeat. Dolores occaecati omnis.",
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"publication_website": "goldnerhomenick.io",
"publication_name": "Lubowitz LLC",
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
}
Getting a Creator
Request
curl -g "http://localhost:3000/api/v1/professionals/2dde5aa0-a061-42c4-9022-2f9f1d873f29" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: george_simonis@hoegergibson.org" \
-H "Authorization: FSzRGWx_Guz8GBtxQyZ5" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:id
GET /api/v1/professionals/2dde5aa0-a061-42c4-9022-2f9f1d873f29
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "2dde5aa0-a061-42c4-9022-2f9f1d873f29",
"type": "professional",
"attributes": {
"fullname": "Tyron Hahn",
"email": "noreen@grantstreich.com",
"bio": null,
"username": "tyron-hahn-0c66ae67-6e2f-46fe-a7fc-14d3b9c8b208",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"platform_bio": null,
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
}
Getting an Influencer
Request
curl -g "http://localhost:3000/api/v1/professionals/95686166-f1e9-4649-8e93-ac0ac27390ce" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: aisha@schneider.co" \
-H "Authorization: 8gaPbkizJMqowpeLmREs" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:id
GET /api/v1/professionals/95686166-f1e9-4649-8e93-ac0ac27390ce
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "95686166-f1e9-4649-8e93-ac0ac27390ce",
"type": "professional",
"attributes": {
"fullname": "Bradly Cummerata",
"email": "matthew@cummerata.info",
"bio": null,
"username": "bradly-cummerata-62ca8626-a9d2-47bf-bfab-be942f7d6fa3",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment"
],
"platform_bio": "Asperiores quas commodi. Quod sapiente omnis. Aut consequatur ex.",
"currency": "USD",
"locations": [
"Lagos"
],
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$10,000",
"formated_naira_value": "₦4,700,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$5,000",
"formated_naira_value": "₦2,350,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$9,000",
"formated_naira_value": "₦4,230,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$7,000",
"formated_naira_value": "₦3,290,000",
"value": 7000
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/professionals/a" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: domenic@wolf.co" \
-H "Authorization: 5udXKyhyA89pLEzBpZEU" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:id
GET /api/v1/professionals/a
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Professional - Profile
Getting an influencer's profile
Request
curl -g "http://localhost:3000/api/v1/professionals/profile?username=nathanial-ernser-43758b00-0332-4b80-bc2e-0ee5e9b7da1c" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/profile
GET /api/v1/professionals/profile?username=nathanial-ernser-43758b00-0332-4b80-bc2e-0ee5e9b7da1c
Accept: application/json
Content-Type: application/json
Parameters
username: nathanial-ernser-43758b00-0332-4b80-bc2e-0ee5e9b7da1c
| Name | Description |
|---|---|
| username required | Username of associated user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "43758b00-0332-4b80-bc2e-0ee5e9b7da1c",
"type": "user",
"attributes": {
"fullname": "Nathanial Ernser",
"username": "nathanial-ernser-43758b00-0332-4b80-bc2e-0ee5e9b7da1c",
"email": "paz.gleason@lemke.io",
"firstname": "Nathanial",
"lastname": "Ernser",
"bio": null,
"location": null,
"date_joined": "June, 2021",
"profile_image_url": "http://pbgyu.com/profile_img",
"request_currency": "USD",
"accounts": [
{
"youtube": {
"data": {
"id": "e4ff0c8f-7568-47bf-97cc-dede5e1ebca6",
"provider_identifier": "UcGQ00Rvc",
"profile_image": "http://pbgyu.com/profile_img",
"username": "UcGQ00Rvc",
"name": "Odinma Umah",
"bio": "",
"followers_count": 9000,
"total_posts_count": 3,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"professional": {
"data": {
"id": "0c17595f-a10e-4d41-9b96-bd7a23d5888a",
"type": "professional",
"attributes": {
"fullname": "Nathanial Ernser",
"email": "paz.gleason@lemke.io",
"bio": null,
"username": "nathanial-ernser-43758b00-0332-4b80-bc2e-0ee5e9b7da1c",
"profile_image_url": "http://pbgyu.com/profile_img",
"cover_image_url": "http://pbgyu.com/profile_img",
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment"
],
"platform_bio": "Ut sint quis. Quaerat doloribus assumenda. Voluptatem nemo ipsum.",
"currency": "USD",
"locations": [
"Lagos"
],
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$10,000",
"formated_naira_value": "₦4,700,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$5,000",
"formated_naira_value": "₦2,350,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$9,000",
"formated_naira_value": "₦4,230,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$7,000",
"formated_naira_value": "₦3,290,000",
"value": 7000
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"portfolios": null
}
}
}
Getting a publisher's profile
Request
curl -g "http://localhost:3000/api/v1/professionals/profile?username=aundrea-wintheiser-bfcbbc89-c02f-4b57-bea2-743dfee4379c" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/profile
GET /api/v1/professionals/profile?username=aundrea-wintheiser-bfcbbc89-c02f-4b57-bea2-743dfee4379c
Accept: application/json
Content-Type: application/json
Parameters
username: aundrea-wintheiser-bfcbbc89-c02f-4b57-bea2-743dfee4379c
| Name | Description |
|---|---|
| username required | Username of associated user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "bfcbbc89-c02f-4b57-bea2-743dfee4379c",
"type": "user",
"attributes": {
"fullname": "Aundrea Wintheiser",
"username": "aundrea-wintheiser-bfcbbc89-c02f-4b57-bea2-743dfee4379c",
"email": "milia@harveyschiller.io",
"firstname": "Aundrea",
"lastname": "Wintheiser",
"bio": null,
"location": null,
"date_joined": "June, 2021",
"profile_image_url": "",
"request_currency": "USD",
"accounts": [
],
"professional": {
"data": {
"id": "13888724-2665-49f1-9535-bd63e35f6cda",
"type": "professional",
"attributes": {
"fullname": "Aundrea Wintheiser",
"email": "milia@harveyschiller.io",
"bio": null,
"username": "aundrea-wintheiser-bfcbbc89-c02f-4b57-bea2-743dfee4379c",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"platform_bio": "Tempore non harum. Inventore cupiditate quas. Eaque nobis suscipit.",
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"publication_website": "hamill.org",
"publication_name": "Kovacek, Stanton and Jacobson",
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"portfolios": {
"data": [
{
"id": "dcb32785-f658-4fc5-b5de-ffcacf4776a9",
"type": "portfolio",
"attributes": {
"professional_id": "13888724-2665-49f1-9535-bd63e35f6cda",
"title": null,
"description": "Nemo repellat est. Numquam nesciunt et. Et aut nemo.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxrWXpBMU5EWmhZaTAxTURsbUxUUmtaVGt0T0RreVlpMDNNemxtWlRreE1HVmpPR1lHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--f7bcdbf94565d40863e4237aae831918cc353a13/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
},
{
"id": "d89c2f38-216f-400d-8dd1-367b68c910fa",
"type": "portfolio",
"attributes": {
"professional_id": "13888724-2665-49f1-9535-bd63e35f6cda",
"title": null,
"description": "Et sint iste. Et placeat deserunt. Impedit tempore est.",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt5WVRoaU5URmlOQzAwWlRrMExUUTNaRE10T1dJME1DMWhOV1JtTnpnellXSmhOMlFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--8059bad47a4754a369729f3cc2b134d6c49daa7e/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
}
}
With invalid username
Request
curl -g "http://localhost:3000/api/v1/professionals/profile?username=american" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/profile
GET /api/v1/professionals/profile?username=american
Accept: application/json
Content-Type: application/json
Parameters
username: american
| Name | Description |
|---|---|
| username required | Username of associated user |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Professional - Top Posts
With three valid accounts
Request
curl -g "http://localhost:3000/api/v1/professionals/e447aa64-6254-424a-817c-562d23e9e6f3/top_posts" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: testuser@twitter.com" \
-H "Authorization: 1JsQzx8EJokggLxXo5cv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/top_posts
GET /api/v1/professionals/e447aa64-6254-424a-817c-562d23e9e6f3/top_posts
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"twitter": [
{
"post_id": "244111636544225280",
"post_url": "https://twitter.com/Omeni/status/244111636544225280"
},
{
"post_id": "244111636544225280",
"post_url": "https://twitter.com/Omeni/status/244111636544225280"
}
],
"youtube": [
{
"post_id": "GQ00Rvc",
"post_title": "Song by me",
"post_url": "https://www.youtube.com/embeb/GQ00Rvc"
},
{
"post_id": "vYilNc",
"post_title": "Song by them",
"post_url": "https://www.youtube.com/embeb/vYilNc"
}
],
"instagram": [
{
"post_id": "17916927248",
"post_url": "https://www.instagram.com/p/TUBFY2N/"
},
{
"post_id": "179448347058",
"post_url": "https://www.instagram.com/p/PPFY2NGH/"
}
]
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/professionals/586c9242-63f3-4655-98e0-a125d742537e/top_posts" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/top_posts
GET /api/v1/professionals/586c9242-63f3-4655-98e0-a125d742537e/top_posts
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Professional - Influencer Posts
Fetching Twitter Posts
Request
curl "http://localhost:3000/api/v1/professionals/751b0f32-0457-4534-bf59-987fbf58775d/influencer_posts" -d '{"provider":"twitter","hashtag":"#Run4Life"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: testuser@twitter.com" \
-H "Authorization: fxTMfzd8z-KtoUaVzTyo" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/influencer_posts
POST /api/v1/professionals/751b0f32-0457-4534-bf59-987fbf58775d/influencer_posts
Accept: application/json
Content-Type: application/json
Parameters
{"provider":"twitter","hashtag":"#Run4Life"}
| Name | Description |
|---|---|
| provider | Social media platform |
| keyword | Keyword for Campaign |
| hashtag | Hashtag for Campaign |
| proposal_id | Instagram only - Proposal id for deliverable |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"hashtag": "#Run4Life",
"keyword": null,
"posts": [
]
}
Fetching Youtube Posts
Request
curl "http://localhost:3000/api/v1/professionals/b4a30178-5b1d-4d0c-9151-20360659d3ca/influencer_posts" -d '{"provider":"youtube","keyword":"song","proposal_id":"d5596ac0-5182-4dd5-9851-f89436b030d2"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: annis@gusikowski.name" \
-H "Authorization: NkVR6rsg-nRsQrNskxcm" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/influencer_posts
POST /api/v1/professionals/b4a30178-5b1d-4d0c-9151-20360659d3ca/influencer_posts
Accept: application/json
Content-Type: application/json
Parameters
{"provider":"youtube","keyword":"song","proposal_id":"d5596ac0-5182-4dd5-9851-f89436b030d2"}
| Name | Description |
|---|---|
| provider | Social media platform |
| keyword | Keyword for Campaign |
| hashtag | Hashtag for Campaign |
| proposal_id | Instagram only - Proposal id for deliverable |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"hashtag": null,
"keyword": "song",
"posts": [
{
"id": "GQ00Rvc",
"created_at": "2021-06-09T08:58:30.934+01:00",
"post_url": "https://www.youtube.com/embed/GQ00Rvc"
}
]
}
Fetching Instagram Posts
Request
curl "http://localhost:3000/api/v1/professionals/e5317e6f-7bcb-45fa-adf8-7c341bb68157/influencer_posts" -d '{"provider":"instagram","keyword":"SocialCred","proposal_id":"5359b7d2-c2b4-4597-982d-7b0dac3499f0"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: miles_blick@kozey.net" \
-H "Authorization: uBJT1EG1NHffVjuw7smi" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/influencer_posts
POST /api/v1/professionals/e5317e6f-7bcb-45fa-adf8-7c341bb68157/influencer_posts
Accept: application/json
Content-Type: application/json
Parameters
{"provider":"instagram","keyword":"SocialCred","proposal_id":"5359b7d2-c2b4-4597-982d-7b0dac3499f0"}
| Name | Description |
|---|---|
| provider | Social media platform |
| keyword | Keyword for Campaign |
| hashtag | Hashtag for Campaign |
| proposal_id | Instagram only - Proposal id for deliverable |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"hashtag": null,
"keyword": "SocialCred",
"posts": [
{
"id": "179448347058",
"created_at": "2050-06-16T15:35:34+0000",
"post_url": "https://www.instagram.com/p/PPFY2NGH/"
}
]
}
Without Authentication
Request
curl "http://localhost:3000/api/v1/professionals/f413fc7e-9311-4d4b-b435-f34dca647e6e/influencer_posts" -d '{"provider":"twitter","hashtag":"#Run4Life"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/influencer_posts
POST /api/v1/professionals/f413fc7e-9311-4d4b-b435-f34dca647e6e/influencer_posts
Accept: application/json
Content-Type: application/json
Parameters
{"provider":"twitter","hashtag":"#Run4Life"}
| Name | Description |
|---|---|
| provider | Social media platform |
| keyword | Keyword for Campaign |
| hashtag | Hashtag for Campaign |
| proposal_id | Instagram only - Proposal id for deliverable |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When Social Account is not connected
Request
curl "http://localhost:3000/api/v1/professionals/0175a08f-1ded-49e6-8ef9-f0a8ea20c1e6/influencer_posts" -d '{"provider":"youtube","hashtag":"#Run4Life"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: testuser@twitter.com" \
-H "Authorization: QvcKWm3HChTzayS76d3D" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/influencer_posts
POST /api/v1/professionals/0175a08f-1ded-49e6-8ef9-f0a8ea20c1e6/influencer_posts
Accept: application/json
Content-Type: application/json
Parameters
{"provider":"youtube","hashtag":"#Run4Life"}
| Name | Description |
|---|---|
| provider | Social media platform |
| keyword | Keyword for Campaign |
| hashtag | Hashtag for Campaign |
| proposal_id | Instagram only - Proposal id for deliverable |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "You need to connect your youtube account before you cansubmit this deliverable"
}
}
}
Professional - Update
Successful with with valid params
Request
curl "http://localhost:3000/api/v1/professionals/db3d50e7-546c-48a7-9345-fd4576b4b12a" -d '{"professional":{"niche":["advert","branding"]}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: yang_schmeler@paucek.name" \
-H "Authorization: HVWyrXTLfvbqAN_rV57y" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:id
PATCH /api/v1/professionals/db3d50e7-546c-48a7-9345-fd4576b4b12a
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"niche":["advert","branding"]}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | All - Available services offered |
| professional[niche] | All - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "133a0918-c47c-47bc-a3d0-6d0c8145a86e",
"type": "authenticated_user",
"attributes": {
"fullname": "Tristan Walter",
"username": "tristan-walter-133a0918-c47c-47bc-a3d0-6d0c8145a86e",
"email": "yang_schmeler@paucek.name",
"firstname": "Tristan",
"lastname": "Walter",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "HVWyrXTLfvbqAN_rV57y",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": "15374769-e502-45d2-892a-805c4099889c",
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": {
"data": {
"id": "db3d50e7-546c-48a7-9345-fd4576b4b12a",
"type": "professional",
"attributes": {
"fullname": "Tristan Walter",
"email": "yang_schmeler@paucek.name",
"bio": null,
"username": "tristan-walter-133a0918-c47c-47bc-a3d0-6d0c8145a86e",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"advert",
"branding"
],
"platform_bio": "Deserunt enim autem. Voluptatem a nihil. Enim amet corrupti.",
"currency": "USD",
"phone_number": null,
"country_code": "US",
"tin": null,
"avg_ratings": 0.0,
"publication_website": "douglasziemann.name",
"publication_name": "O'Connell Group",
"charge_from": {
"formated_dollar_value": "$70,000",
"formated_naira_value": "₦32,900,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$250,000",
"formated_naira_value": "₦117,500,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accepted_projects_count": 0,
"projects_completion_rate": 0,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"business": null,
"profile_image_url": ""
}
}
}
With another user's profile
Request
curl "http://localhost:3000/api/v1/professionals/150e7837-b19d-4436-a692-995861d12069" -d '{"professional":{"niche":["advert","branding"]}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: gita.vandervort@lubowitzparisian.name" \
-H "Authorization: Ka7qYtgcYPDD5qijqTdb" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:id
PATCH /api/v1/professionals/150e7837-b19d-4436-a692-995861d12069
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"niche":["advert","branding"]}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | All - Available services offered |
| professional[niche] | All - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
204 No Content
With invalid params
Request
curl "http://localhost:3000/api/v1/professionals/05ec875d-6a91-4074-b776-c01fb96e7195" -d '{"professional":{"professional_type":"","niche":["advert","branding"]}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tennille.runte@balistreriwill.name" \
-H "Authorization: 5FczyEhBSat_qxanZH9T" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:id
PATCH /api/v1/professionals/05ec875d-6a91-4074-b776-c01fb96e7195
Accept: application/json
Content-Type: application/json
Parameters
{"professional":{"professional_type":"","niche":["advert","branding"]}}
| Name | Description |
|---|---|
| professional[professional_type] required | All - Type of professional |
| professional[publication_name] | Publishers - Name of platform |
| professional[publication_website] | Publishers - Website of platform |
| professional[services] | All - Available services offered |
| professional[niche] | All - Areas of focus |
| professional[platform_bio] | Publishers - Description of platform |
| professional[locations] | Influencers - Locations they cover |
| professional[charge_from] | All - Minimum Amount they can collect |
| professional[charge_to] | All - Maxinmum Amount they can collect |
| professional[post_with_photo_fee] | Influencers - post with photo fee |
| professional[post_with_carousel_fee] | Influencers - post with carousel fee |
| professional[post_with_video_fee] | Influencers - post with video fee |
| professional[live_video_fee] | Influencers - live video fee |
| professional[story_fee] | Influencers - story fee |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "05ec875d-6a91-4074-b776-c01fb96e7195",
"type": "professional",
"errors": [
{
"source": {
"pointer": "/data/attributes/professional_type"
},
"detail": "Professional_type can't be blank",
"title": "can't be blank"
}
]
}
Professional - Search
Search without queries/filters returns all records
Request
curl -g "http://localhost:3000/api/v1/professionals/search" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": 2,
"total_pages": 7,
"total_count": 58
}
}
}
Search with query
Request
curl -g "http://localhost:3000/api/v1/professionals/search?query=Florence" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?query=Florence
Accept: application/json
Content-Type: application/json
Parameters
query: Florence
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "553e3c5d-137d-4012-ab43-cbb019bdca63",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "roosevelt.skiles@harris.co",
"bio": null,
"username": "florence-treasures-5afadf2c-5d44-4bd0-b9f8-591dab9f7c25",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "0f87dfd5-ed18-4e3d-9ba1-5bd6660be0b3",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 5000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with professional_type
Request
curl -g "http://localhost:3000/api/v1/professionals/search?professional_type=creator%2C+publisher" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?professional_type=creator%2C+publisher
Accept: application/json
Content-Type: application/json
Parameters
professional_type: creator, publisher
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "db3ac695-a49c-4064-b875-59cd961a1fba",
"type": "professional_search",
"attributes": {
"fullname": "Brandy Pierre",
"email": "athena.tromp@bode.co",
"bio": null,
"username": "brandy-pierre-352a37a9-e4b7-4f7a-8b4b-f157584b0a2a",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"currency": "NGN",
"platform_bio": "When it comes to awesomeness, we are the best",
"avg_ratings": 0.0,
"publication_website": "brancom.co",
"publication_name": "Branco Publishing Company",
"charge_from": {
"formated_dollar_value": "$148.94",
"formated_naira_value": "₦70,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$531.91",
"formated_naira_value": "₦250,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "1e11b364-eaaf-46ea-a30d-3830477cc55b",
"type": "portfolio",
"attributes": {
"professional_id": "db3ac695-a49c-4064-b875-59cd961a1fba",
"title": null,
"description": "7 tips on communication",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6TlRVME1tRmtOeTAxWmpRekxUUTFOV1F0T0RCak9TMWpNalJpTldJd1kySTNOVFlHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--0794cc012478efe7de9934f3816281cfa1a8bba9/fruits.jpeg"
},
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxsTURSa1pEWTJNQzFpTXpWbExUUTJaamd0T1dFeU9TMDNZMlZsT1dFNFltRmhPVE1HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--9894dc1aaec32644ad2144b230f68c6af227bb13/doc.pdf"
}
],
"published_at": "June, 2021"
}
}
]
}
}
},
{
"id": "8d13c6b4-8059-4a70-b774-e64737bdccf8",
"type": "professional_search",
"attributes": {
"fullname": "Coranda Joblom",
"email": "theresa.bayer@lebsack.co",
"bio": "Cool and beautiful company, the best in town",
"username": "coranda-joblom-324757dc-c56c-4b92-8080-e2f5b8b2b7c0",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"currency": "NGN",
"platform_bio": "Cool and beautiful company, the best in town",
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$127.66",
"formated_naira_value": "₦60,000",
"value": 60000
},
"charge_to": {
"formated_dollar_value": "$638.30",
"formated_naira_value": "₦300,000",
"value": 300000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "50ef5c54-6991-45dd-b7a4-849ee33344d9",
"type": "portfolio",
"attributes": {
"professional_id": "8d13c6b4-8059-4a70-b774-e64737bdccf8",
"title": "Dominic Banners",
"description": "Banner Designs for Presidential campaign",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1TXpNek4yTmxPUzB4WlRoaUxUUmpaVFV0WWpZME5DMDJPV0ZqWWpFeU0yTmxNRFlHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--65e3d52445f86414fdcf8bcaac1bc35f7e21b228/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 2
}
}
}
Search with services
Request
curl -g "http://localhost:3000/api/v1/professionals/search?services=press+release" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?services=press+release
Accept: application/json
Content-Type: application/json
Parameters
services: press release
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "56df9176-0af2-4771-aa46-90baaf4173f2",
"type": "professional_search",
"attributes": {
"fullname": "Brandy Pierre",
"email": "cody@baumbach.biz",
"bio": null,
"username": "brandy-pierre-480ef507-5175-4bf1-bb5b-b63036ef2c68",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"currency": "NGN",
"platform_bio": "When it comes to awesomeness, we are the best",
"avg_ratings": 0.0,
"publication_website": "brancom.co",
"publication_name": "Branco Publishing Company",
"charge_from": {
"formated_dollar_value": "$148.94",
"formated_naira_value": "₦70,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$531.91",
"formated_naira_value": "₦250,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "e558ea15-24e9-4ed1-8aa4-e63f34aefd6c",
"type": "portfolio",
"attributes": {
"professional_id": "56df9176-0af2-4771-aa46-90baaf4173f2",
"title": null,
"description": "7 tips on communication",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt3TURsaFlXTXdNaTFsTmpobExUUmtZbUV0T1dVM09DMDJNRGcxWXpFeFkyVTBObVVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--ea2cde3cd728cad4f545e54663706ff0f7b67699/fruits.jpeg"
},
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt4WTJVd1pETmtZeTAxT0dWaUxUUmtOV0V0WVdVeU1TMDVOV1k0TmpKbVpXSmhPV0VHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--2993f70035306d91b013abb1cbbec370c60ec3fd/doc.pdf"
}
],
"published_at": "June, 2021"
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with niche
Request
curl -g "http://localhost:3000/api/v1/professionals/search?niche=entertainment%2C+advert" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?niche=entertainment%2C+advert
Accept: application/json
Content-Type: application/json
Parameters
niche: entertainment, advert
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "16a3874c-6ac5-44fe-8e20-46494554ef4c",
"type": "professional_search",
"attributes": {
"fullname": "Brandy Pierre",
"email": "rex.bernhard@schowalter.com",
"bio": null,
"username": "brandy-pierre-df4562cb-2511-445a-a8e1-a1ae46972c22",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"currency": "NGN",
"platform_bio": "When it comes to awesomeness, we are the best",
"avg_ratings": 0.0,
"publication_website": "brancom.co",
"publication_name": "Branco Publishing Company",
"charge_from": {
"formated_dollar_value": "$148.94",
"formated_naira_value": "₦70,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$531.91",
"formated_naira_value": "₦250,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "bc7c21d0-e497-474a-83da-2d0a83f8e083",
"type": "portfolio",
"attributes": {
"professional_id": "16a3874c-6ac5-44fe-8e20-46494554ef4c",
"title": null,
"description": "7 tips on communication",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtWkRsaE5XUXpOaTB4TmpVekxUUmlaVGd0T0dGak55MDRPV0ZqWWpKak5UY3hObU1HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--00870838bcf796d5ea1954cc7fa9a34b032ee797/doc.pdf"
},
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxtWm1WbVpURXpOQzAxWVdNMkxUUTFPRGd0WVRrd01DMDVaVFkxTldReE1XRTJPV1FHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--e99b7e04d8c144ddf413d33b2095a3a12f120ba3/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
},
{
"id": "03aec7cd-aec2-4f0e-8431-864550fccd7b",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "dee_hartmann@halvorson.info",
"bio": null,
"username": "florence-treasures-cf5255d1-a287-4476-8655-7daf22b87040",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "adf410ff-c77f-457e-902d-61b3f7f962e9",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 5000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 2
}
}
}
Search with only charge_from
Request
curl -g "http://localhost:3000/api/v1/professionals/search?charge_from=280_000¤cy=NGN" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?charge_from=280_000&currency=NGN
Accept: application/json
Content-Type: application/json
Parameters
charge_from: 280_000
currency: NGN
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "NGN",
"results": {
"data": [
{
"id": "25f0bb68-1289-440f-bf58-b035616362cc",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "jermaine.haag@flatley.info",
"bio": null,
"username": "florence-treasures-b2b2c729-8128-49cb-a275-e9865c6b59ec",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "2a2f7259-8cc8-4775-ab63-b5a344395e3e",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 5000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
},
{
"id": "8427bd11-2ff2-4307-81d8-76e54f4415c4",
"type": "professional_search",
"attributes": {
"fullname": "Coranda Joblom",
"email": "akiko_ferry@mcglynn.name",
"bio": "Cool and beautiful company, the best in town",
"username": "coranda-joblom-4a81440d-56b7-447b-a18e-d6becfc43ba9",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"currency": "NGN",
"platform_bio": "Cool and beautiful company, the best in town",
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$127.66",
"formated_naira_value": "₦60,000",
"value": 60000
},
"charge_to": {
"formated_dollar_value": "$638.30",
"formated_naira_value": "₦300,000",
"value": 300000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "00ed928e-c40a-44bc-8477-d83eea55ff30",
"type": "portfolio",
"attributes": {
"professional_id": "8427bd11-2ff2-4307-81d8-76e54f4415c4",
"title": "Dominic Banners",
"description": "Banner Designs for Presidential campaign",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs0WVRNME5qTTJNaTFoTVdJMExUUmxZMk10WWpZeU1pMW1aV0UxT0RnNFpHUmhNR0VHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--ad1c53037f5aeb4ec07fff672f0c0c796f9092d2/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 2
}
}
}
Search with charge_to
Request
curl -g "http://localhost:3000/api/v1/professionals/search?charge_to=300¤cy=USD" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?charge_to=300&currency=USD
Accept: application/json
Content-Type: application/json
Parameters
charge_to: 300
currency: USD
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "f7af518c-f56f-4f84-ba44-c29bbb06d352",
"type": "professional_search",
"attributes": {
"fullname": "Brandy Pierre",
"email": "asha@gleichnerhills.org",
"bio": null,
"username": "brandy-pierre-8fe31dfe-b7ec-4a9a-9359-fc941676665b",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"currency": "NGN",
"platform_bio": "When it comes to awesomeness, we are the best",
"avg_ratings": 0.0,
"publication_website": "brancom.co",
"publication_name": "Branco Publishing Company",
"charge_from": {
"formated_dollar_value": "$148.94",
"formated_naira_value": "₦70,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$531.91",
"formated_naira_value": "₦250,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "961b7c2c-1176-46d1-a618-9c2dcd3145ad",
"type": "portfolio",
"attributes": {
"professional_id": "f7af518c-f56f-4f84-ba44-c29bbb06d352",
"title": null,
"description": "7 tips on communication",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWszT0RObU4yWTFaUzFoT1dZd0xUUTROekl0T0RReE1DMDJZamd4TTJNNFpHRXhZVGNHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--a2d1f3129b3c63ea619143ff9ffc92c1e420e1a6/fruits.jpeg"
},
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1WXprelpqWmhaUzA0TldKbExUUTNNbU10WVRabU1DMWhZelV5TkdVNFpEazNNRGNHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--6d0ceb09ca81239c86c15feb9cc3f43aa0da0b62/doc.pdf"
}
],
"published_at": "June, 2021"
}
}
]
}
}
},
{
"id": "937140d0-a05a-480c-8366-ead9e8b00091",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "kerstin@sauerbruen.org",
"bio": null,
"username": "florence-treasures-8599d9f2-67ee-4fff-a90e-5093265b65bb",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "e59aa50b-912f-48f4-9312-ca2b78266457",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 5000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
},
{
"id": "376e3d38-0adc-491b-be3c-695147d0a9fd",
"type": "professional_search",
"attributes": {
"fullname": "Coranda Joblom",
"email": "katerine@nader.io",
"bio": "Cool and beautiful company, the best in town",
"username": "coranda-joblom-ede1b268-7792-45d3-8700-d9b50b03be90",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"currency": "NGN",
"platform_bio": "Cool and beautiful company, the best in town",
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$127.66",
"formated_naira_value": "₦60,000",
"value": 60000
},
"charge_to": {
"formated_dollar_value": "$638.30",
"formated_naira_value": "₦300,000",
"value": 300000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "9f97e0fe-e367-4b6f-a244-c305847885d4",
"type": "portfolio",
"attributes": {
"professional_id": "376e3d38-0adc-491b-be3c-695147d0a9fd",
"title": "Dominic Banners",
"description": "Banner Designs for Presidential campaign",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxsWmpWaE5XRm1ZUzB4Tm1JMUxUUTFOMkV0T1RZd05pMDVNREUzWmpBM01EWXpaVFFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--bea609450f793df1453ec9951975828f216023f3/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 3
}
}
}
Search with charge_from and charge_to
Request
curl -g "http://localhost:3000/api/v1/professionals/search?charge_from=80_000&charge_to=100_000¤cy=NGN" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?charge_from=80_000&charge_to=100_000&currency=NGN
Accept: application/json
Content-Type: application/json
Parameters
charge_from: 80_000
charge_to: 100_000
currency: NGN
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "NGN",
"results": {
"data": [
{
"id": "e06226e7-00dc-4d88-8712-83836911f528",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "jetta@purdywindler.com",
"bio": null,
"username": "florence-treasures-b90f64f6-1b71-4950-a3de-d7247e3c5e92",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "731da01f-b3fd-467f-bd8d-861f03471e71",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 5000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
},
{
"id": "ad24c6e5-2181-4573-b2dd-25bcba21f04f",
"type": "professional_search",
"attributes": {
"fullname": "Brandy Pierre",
"email": "mica@boganlemke.io",
"bio": null,
"username": "brandy-pierre-6a1e9ad7-d909-4229-aca0-ab5ced547ab4",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"currency": "NGN",
"platform_bio": "When it comes to awesomeness, we are the best",
"avg_ratings": 0.0,
"publication_website": "brancom.co",
"publication_name": "Branco Publishing Company",
"charge_from": {
"formated_dollar_value": "$148.94",
"formated_naira_value": "₦70,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$531.91",
"formated_naira_value": "₦250,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "326c7e81-7b73-43b1-829f-2371610204a5",
"type": "portfolio",
"attributes": {
"professional_id": "ad24c6e5-2181-4573-b2dd-25bcba21f04f",
"title": null,
"description": "7 tips on communication",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt4WldZd1ptWmxZeTAwT1RNMUxUUTFZakV0T0dKak15MHpabVU0T1RobE1UTTNZeklHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--9e83319f2c5fed643d194616ca17b077722e06a6/doc.pdf"
},
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6WVRBM1lUSmhaUzB4WWpobUxUUTVaRGN0T0dNM1lpMDVOR0V4TTJVMU4yVTRPVFFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--2dff8f7bbee03914bd2c89934fdbc89d15db3be9/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
},
{
"id": "2e5af6ef-8fa9-4297-8eeb-f65120410ad9",
"type": "professional_search",
"attributes": {
"fullname": "Coranda Joblom",
"email": "rolando@hermannfeest.com",
"bio": "Cool and beautiful company, the best in town",
"username": "coranda-joblom-e6aca49a-95d3-4d47-93df-f3bcd8b2f63d",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"currency": "NGN",
"platform_bio": "Cool and beautiful company, the best in town",
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$127.66",
"formated_naira_value": "₦60,000",
"value": 60000
},
"charge_to": {
"formated_dollar_value": "$638.30",
"formated_naira_value": "₦300,000",
"value": 300000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "cd290b44-0e4c-4e02-b963-bc3f7622c252",
"type": "portfolio",
"attributes": {
"professional_id": "2e5af6ef-8fa9-4297-8eeb-f65120410ad9",
"title": "Dominic Banners",
"description": "Banner Designs for Presidential campaign",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt4TkRVeFlqRmlZaTB4TmpBekxUUmlaVFV0WVdWbFlpMDVZemRrTTJKalpUSmpOV01HT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--c5d98efa7f965f20463236b095b6c34b8698d957/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 3
}
}
}
Search with Dollar Currency
Request
curl -g "http://localhost:3000/api/v1/professionals/search?charge_from=250&charge_to=650¤cy=USD" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?charge_from=250&charge_to=650&currency=USD
Accept: application/json
Content-Type: application/json
Parameters
charge_from: 250
charge_to: 650
currency: USD
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "95fe3af8-dda9-4976-996c-194c05ecaccf",
"type": "professional_search",
"attributes": {
"fullname": "Brandy Pierre",
"email": "kevin@schuppe.com",
"bio": null,
"username": "brandy-pierre-c63a5f27-92f2-4020-a315-3814a77a47fd",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "publisher",
"services": [
"Press Release",
"Documentations"
],
"niche": [
"Advert",
"Publications"
],
"currency": "NGN",
"platform_bio": "When it comes to awesomeness, we are the best",
"avg_ratings": 0.0,
"publication_website": "brancom.co",
"publication_name": "Branco Publishing Company",
"charge_from": {
"formated_dollar_value": "$148.94",
"formated_naira_value": "₦70,000",
"value": 70000
},
"charge_to": {
"formated_dollar_value": "$531.91",
"formated_naira_value": "₦250,000",
"value": 250000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "e525d57f-87b0-4037-abd7-a8b70b9e28d5",
"type": "portfolio",
"attributes": {
"professional_id": "95fe3af8-dda9-4976-996c-194c05ecaccf",
"title": null,
"description": "7 tips on communication",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "doc.pdf",
"file_type": "application/pdf",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6TURrek16ZGxZUzFsWXpRM0xUUmlOakV0WW1VMFlTMHdOVEJrWkRNd1pEUTRPR0lHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--60cd631a95c3b32f63bf0f00913782cfd092f086/doc.pdf"
},
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxpTURreE9XRTBOeTAzTldObUxUUmhOVFl0T0dNeU15MWxPREZpTVRjME1EVmtPVGtHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--f04016060f199fab4f0abce0129218ce64333a66/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
},
{
"id": "67a54203-f228-4b61-a718-b2fb3252cce4",
"type": "professional_search",
"attributes": {
"fullname": "Coranda Joblom",
"email": "hugo@durgan.co",
"bio": "Cool and beautiful company, the best in town",
"username": "coranda-joblom-7806072b-89fc-4c7d-b2b2-1edd444f5be9",
"profile_image_url": "",
"cover_image_url": "",
"professional_type": "creator",
"services": [
"Designs Logo Banner"
],
"niche": [
],
"currency": "NGN",
"platform_bio": "Cool and beautiful company, the best in town",
"avg_ratings": 0.0,
"charge_from": {
"formated_dollar_value": "$127.66",
"formated_naira_value": "₦60,000",
"value": 60000
},
"charge_to": {
"formated_dollar_value": "$638.30",
"formated_naira_value": "₦300,000",
"value": 300000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"accounts": [
],
"portfolios": {
"data": [
{
"id": "54dbfed4-8a1a-484f-81e0-b526b01d7775",
"type": "portfolio",
"attributes": {
"professional_id": "67a54203-f228-4b61-a718-b2fb3252cce4",
"title": "Dominic Banners",
"description": "Banner Designs for Presidential campaign",
"publication_type": "article",
"link": null,
"tags": [
"Writing",
"Proof-reading"
],
"services": [
],
"completed_at": "2020-02-20",
"documents": [
{
"filename": "fruits.jpeg",
"file_type": "image/jpeg",
"url": "http://localhost:3000/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWs1TVRBMll6a3hPUzA0TjJVeExUUTFPV010WW1VM1lTMDJNVE14TkRReFpXSmpOV1FHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--140ed29b9021aee9e9b255d7b924c90abcf315b8/fruits.jpeg"
}
],
"published_at": "June, 2021"
}
}
]
}
}
},
{
"id": "c7ea04a6-ed68-4b2c-bd26-a0b73e83ad0c",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "willow@buckridgewillms.net",
"bio": null,
"username": "florence-treasures-492abe1e-9c57-4ad5-96e5-21a0441fb757",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "15825b9d-f351-4b2a-8a21-0f4eb686c5e3",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 5000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 3
}
}
}
Search that includes influencer rate card
Request
curl -g "http://localhost:3000/api/v1/professionals/search?charge_from=5_000&charge_to=10_000¤cy=NGN" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?charge_from=5_000&charge_to=10_000&currency=NGN
Accept: application/json
Content-Type: application/json
Parameters
charge_from: 5_000
charge_to: 10_000
currency: NGN
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "NGN",
"results": {
"data": [
{
"id": "7d3833b8-cb8f-4dd9-b0aa-c5f0ee413030",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "ashley.kertzmann@macejkovicjacobson.info",
"bio": null,
"username": "florence-treasures-a8b3ad1f-8c15-4357-a2d5-6427dbc91504",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "63d71783-9547-4d33-9c2e-8026be95760d",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 5000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with minimum_followers
Request
curl -g "http://localhost:3000/api/v1/professionals/search?minimum_followers=4000" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?minimum_followers=4000
Accept: application/json
Content-Type: application/json
Parameters
minimum_followers: 4000
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "6635ffa9-85a3-4473-b7fa-cb7bfc9da48b",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "karoline@gusikowskiziemann.co",
"bio": null,
"username": "florence-treasures-950ce542-97ff-43c8-9397-80dd15ee1fba",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "aaedf118-b8b1-4da8-9c85-26911d3104e6",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 7000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with maximum_followers
Request
curl -g "http://localhost:3000/api/v1/professionals/search?maximum_followers=7000" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?maximum_followers=7000
Accept: application/json
Content-Type: application/json
Parameters
maximum_followers: 7000
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "b4b1a5d6-bf74-47c2-8fc8-b168b7a461cc",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "manual@crooks.name",
"bio": null,
"username": "florence-treasures-5b1fce7f-e82f-4e4b-9959-2a2af2a5fcda",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "43d85c62-a4eb-46a8-904d-a30759dbd719",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 6000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with minimum_followers and maximum_followers
Request
curl -g "http://localhost:3000/api/v1/professionals/search?minimum_followers=4500&maximum_followers=6500" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?minimum_followers=4500&maximum_followers=6500
Accept: application/json
Content-Type: application/json
Parameters
minimum_followers: 4500
maximum_followers: 6500
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "9321ff6c-74a7-4b21-9b80-fc31e48f4b6a",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "millard.roberts@goldnermorar.co",
"bio": null,
"username": "florence-treasures-a7abe9cf-e903-4f2d-926d-897771dca5b5",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "6d2d15a6-38fa-43f8-99f8-a6cc556d81b3",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 6000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with country_key
Request
curl -g "http://localhost:3000/api/v1/professionals/search?country_key=NG" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?country_key=NG
Accept: application/json
Content-Type: application/json
Parameters
country_key: NG
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "413956a8-1950-4035-80ce-189ee6e3722a",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "phoebe@brekkegrant.io",
"bio": null,
"username": "florence-treasures-f6049a2e-f8fc-49d6-8d3a-596237d24e25",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "84433789-320a-43cd-bbbe-deb6cad3111f",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 6000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Search with gender_key
Request
curl -g "http://localhost:3000/api/v1/professionals/search?gender_key=male" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/search
GET /api/v1/professionals/search?gender_key=male
Accept: application/json
Content-Type: application/json
Parameters
gender_key: male
| Name | Description |
|---|---|
| query | Text entered by the user |
| professional_type | Filter by professional_type |
| services | Filter by services |
| niche | Filter by niche |
| charge_from | Filter by charge_from |
| charge_to | Filter by charge_to |
| minimum_followers | Filter by minimum_followers |
| maximum_followers | Filter by maximum_followers |
| country_key | Filter by country_key |
| gender_key | Filter by gender_key |
| currency | Currency selected by user - NGN/USD. Default - NGN |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"request_currency": "USD",
"results": {
"data": [
{
"id": "81ae64d8-6d1a-46eb-bcd7-ea04c3d3b291",
"type": "professional_search",
"attributes": {
"fullname": "Florence Treasures",
"email": "monroe.dickinson@schadensporer.com",
"bio": null,
"username": "florence-treasures-6e59a81a-9b8d-4f04-8482-2db48a42a418",
"profile_image_url": null,
"cover_image_url": null,
"professional_type": "influencer",
"services": [
],
"niche": [
"Entertainment",
"Fire-side chats"
],
"currency": "NGN",
"platform_bio": "My service is organic and full of results",
"avg_ratings": 0.0,
"locations": [
"Lagos",
"Abuja"
],
"charge_from": {
"formated_dollar_value": "$212.77",
"formated_naira_value": "₦100,000",
"value": 100000
},
"charge_to": {
"formated_dollar_value": "$1,063.83",
"formated_naira_value": "₦500,000",
"value": 500000
},
"story_fee": {
"formated_dollar_value": "$21.28",
"formated_naira_value": "₦10,000",
"value": 10000
},
"live_video_fee": {
"formated_dollar_value": "$31.91",
"formated_naira_value": "₦15,000",
"value": 15000
},
"post_with_photo_fee": {
"formated_dollar_value": "$10.64",
"formated_naira_value": "₦5,000",
"value": 5000
},
"post_with_video_fee": {
"formated_dollar_value": "$19.15",
"formated_naira_value": "₦9,000",
"value": 9000
},
"post_with_carousel_fee": {
"formated_dollar_value": "$14.89",
"formated_naira_value": "₦7,000",
"value": 7000
},
"accounts": [
{
"instagram": {
"data": {
"id": "59735b9a-3f16-4002-a852-46ce7d4aa214",
"provider_identifier": "FloriT",
"profile_image": null,
"username": "FloriT",
"name": "FlorenceTreasures",
"bio": "Fiery designs for your chats",
"followers_count": 6000,
"total_posts_count": 120,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"portfolios": null
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
}
}
Professional Search - Autocomplete
Returns an array of suggestions
Request
curl -g "http://localhost:3000/api/v1/professionals/autocomplete?query=bran" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/autocomplete
GET /api/v1/professionals/autocomplete?query=bran
Accept: application/json
Content-Type: application/json
Parameters
query: bran
| Name | Description |
|---|---|
| query | Text entered by the user |
Response
Content-Type: application/json; charset=utf-8
200 OK
[
"<em>Bran</em>co Publishing Company",
"<em>Bran</em>dy Pierre"
]
Proposals - Create New Records
Successful with valid params
Request
curl "http://localhost:3000/api/v1/professionals/367831a7-6595-4e5a-b694-620776724a8d/proposals" -d '{"proposal":{"summary":"Fugiat qui distinctio. Dolorem harum illo. Omnis repellat suscipit.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"b21eab1d-e02f-4064-96d2-86771a8bb4a3"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: darrell_witting@beahanbotsford.info" \
-H "Authorization: 1CiobpGjTjFza6TTdUWo" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/367831a7-6595-4e5a-b694-620776724a8d/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Fugiat qui distinctio. Dolorem harum illo. Omnis repellat suscipit.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"b21eab1d-e02f-4064-96d2-86771a8bb4a3"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "70c2f5dc-f92e-4462-89cb-06bb3bfc1384",
"type": "proposal",
"attributes": {
"summary": "Fugiat qui distinctio. Dolorem harum illo. Omnis repellat suscipit.",
"posts": [
{
"post_id": "74283983749",
"url": "http//twurl.6786/tytu"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$22,000",
"formated_naira_value": "₦10,340,000",
"dollar_value": 22000,
"naira_value": 10340000
},
"fee": {
"formated_dollar_value": "$22,000",
"formated_naira_value": "₦10,340,000",
"dollar_value": 22000,
"naira_value": 10340000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "367831a7-6595-4e5a-b694-620776724a8d",
"fullname": "Miguel Schaden",
"username": "miguel-schaden-c4ddcd51-135b-4a57-b37e-5d5c115a8a92",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "0b80e907-c794-43c3-a638-4b05c9b00a6a",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "b21eab1d-e02f-4064-96d2-86771a8bb4a3",
"title": "Logo designs",
"description": "Nam quibusdam dolor. Qui tempore qui. Ut laborum harum.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Breitenberg-Renner",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "5b1faa9a-2373-481f-a666-4801f20a4e43",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
}
}
Business user should not create proposals
Request
curl "http://localhost:3000/api/v1/professionals/c390c78c-c98a-4903-adb7-625a686defbc/proposals" -d '{"proposal":{"summary":"Ut libero molestiae. Deleniti et ullam. Qui porro eos.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"78fe9578-51e6-482c-8e8b-eea7c3228cd6"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: angelika.renner@waters.net" \
-H "Authorization: SxWipxHogir_P57L-T9s" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/c390c78c-c98a-4903-adb7-625a686defbc/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Ut libero molestiae. Deleniti et ullam. Qui porro eos.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"78fe9578-51e6-482c-8e8b-eea7c3228cd6"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
With existing proposal for a job
Request
curl "http://localhost:3000/api/v1/professionals/ef3b072c-6db4-4e87-9973-8d09548149d6/proposals" -d '{"proposal":{"summary":"Labore adipisci omnis. At rerum sit. Pariatur quis earum.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"7fcf032d-84fd-4361-b8db-4997cef9f16e"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: laria_sanford@cole.net" \
-H "Authorization: gvzEZt_qemxVeHvx4qBi" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/ef3b072c-6db4-4e87-9973-8d09548149d6/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Labore adipisci omnis. At rerum sit. Pariatur quis earum.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"7fcf032d-84fd-4361-b8db-4997cef9f16e"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "proposal",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base You can only create one proposal per job",
"title": "You can only create one proposal per job"
}
]
}
Job is completed
Request
curl "http://localhost:3000/api/v1/professionals/1e18b805-6fa4-477c-8047-3f5e2c2d2804/proposals" -d '{"proposal":{"summary":"Consequatur qui ullam. Rem et cupiditate. Omnis deleniti expedita.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"733a177d-d765-451c-bec5-1bba60a03792"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: estefana@armstrong.org" \
-H "Authorization: h4tBsymmPSzxoZE36DE9" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/1e18b805-6fa4-477c-8047-3f5e2c2d2804/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Consequatur qui ullam. Rem et cupiditate. Omnis deleniti expedita.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"733a177d-d765-451c-bec5-1bba60a03792"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "733a177d-d765-451c-bec5-1bba60a03792",
"type": "job",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base This task has ended. You can only accept proposals on ongoing tasks.",
"title": "This task has ended. You can only accept proposals on ongoing tasks."
}
]
}
Job is archived
Request
curl "http://localhost:3000/api/v1/professionals/6faa0a7f-afab-44fb-a78f-fd0aa6e92dcf/proposals" -d '{"proposal":{"summary":"Sed et fugiat. Veniam velit voluptas. Consequatur voluptatum amet.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"8594721c-3dd2-4a28-8b02-ba3ec92c44ff"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: toni.schroeder@jacobi.co" \
-H "Authorization: Nmvc8g2vNsn-LL3FvtnQ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/6faa0a7f-afab-44fb-a78f-fd0aa6e92dcf/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Sed et fugiat. Veniam velit voluptas. Consequatur voluptatum amet.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"8594721c-3dd2-4a28-8b02-ba3ec92c44ff"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "8594721c-3dd2-4a28-8b02-ba3ec92c44ff",
"type": "job",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base This task has ended. You can only accept proposals on ongoing tasks.",
"title": "This task has ended. You can only accept proposals on ongoing tasks."
}
]
}
Publisher should not create proposal for creator jobs
Request
curl "http://localhost:3000/api/v1/professionals/fda23f21-a8ce-4f5a-913d-e4e291b99aa3/proposals" -d '{"proposal":{"summary":"Accusamus corporis labore. Voluptate reiciendis illo. Et vero doloremque.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"9982abf6-4fc4-4774-8081-a5127957c2b0"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: leeann.schuster@bednar.net" \
-H "Authorization: v76KDfU6JqCSxg1AziJj" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/fda23f21-a8ce-4f5a-913d-e4e291b99aa3/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Accusamus corporis labore. Voluptate reiciendis illo. Et vero doloremque.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"9982abf6-4fc4-4774-8081-a5127957c2b0"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "proposal",
"errors": [
{
"source": {
"pointer": "/data/attributes/Professional type:"
},
"detail": "Professional type: You can only apply for your job type",
"title": "You can only apply for your job type"
}
]
}
Fails when summary is blank
Request
curl "http://localhost:3000/api/v1/professionals/ef3c1e47-21e2-4ea8-a309-f950ec8b4186/proposals" -d '{"proposal":{"summary":"","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"b5f5ce7f-11ba-4d6f-951e-bc12aea70538"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tiffiny.lind@treutel.com" \
-H "Authorization: Cq6CSLyyMHUHTPYyH7nP" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/ef3c1e47-21e2-4ea8-a309-f950ec8b4186/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"b5f5ce7f-11ba-4d6f-951e-bc12aea70538"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "proposal",
"errors": [
{
"source": {
"pointer": "/data/attributes/summary"
},
"detail": "Summary can't be blank",
"title": "can't be blank"
}
]
}
When job id is not availabe
Request
curl "http://localhost:3000/api/v1/professionals/b428fbe5-ae6f-4d46-b1f6-3fe50455731d/proposals" -d '{"proposal":{"summary":"Natus voluptas vero. Laudantium dicta atque. Aut laboriosam magni.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"ok-ed-we"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: deirdre.cummerata@johnsbarrows.com" \
-H "Authorization: 3bawLszCkGq1qH15vDpt" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/b428fbe5-ae6f-4d46-b1f6-3fe50455731d/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Natus voluptas vero. Laudantium dicta atque. Aut laboriosam magni.","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"ok-ed-we"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/professionals/c4e91016-2e7c-420c-a105-047b51eedcd6/proposals" -d '{"proposal":{"summary":"","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"1023fc51-7452-4b6e-8ad7-a0d128acb3a4"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/professionals/:professional_id/proposals
POST /api/v1/professionals/c4e91016-2e7c-420c-a105-047b51eedcd6/proposals
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"","posts":[{"post_id":"74283983749","url":"http//twurl.6786/tytu"}],"fee":22000,"job_id":"1023fc51-7452-4b6e-8ad7-a0d128acb3a4"}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
| proposal[job_id] | Job ID for proposal |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Proposals - Get All Proposals for Professional
Getting a proposal for a job
Request
curl -g "http://localhost:3000/api/v1/professionals/30f13c84-94a9-4f7c-9a2b-2131eb03e766/proposals" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: leslie.corwin@hansenwisozk.net" \
-H "Authorization: jaR7wyzuo_RD31GyME4C" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/proposals
GET /api/v1/professionals/30f13c84-94a9-4f7c-9a2b-2131eb03e766/proposals
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "937a81ab-87be-44af-961b-2dd0fcc8220c",
"type": "proposal",
"attributes": {
"summary": "Et commodi earum. Libero tenetur veniam. Labore ratione mollitia.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "30f13c84-94a9-4f7c-9a2b-2131eb03e766",
"fullname": "Sebastian Zieme",
"username": "sebastian-zieme-5f4c6eef-8b6d-48fa-849f-2fcbc6bda827",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "dc39f673-36b0-4e58-9c5e-47602f09d92a",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "f826cb19-f83b-4ec5-a18c-65ddaa14fbfe",
"title": "Logo designs",
"description": "Fugiat impedit veritatis. Delectus nesciunt dignissimos. Odio qui aut.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Hane, Grant and Weissnat",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "634be4a7-12df-47a9-a1a1-e03a081817f0",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
},
{
"id": "c14509a3-f355-4c5b-8d2d-a3986d15e021",
"type": "proposal",
"attributes": {
"summary": "Repellat nesciunt in. Sit modi dolor. Et aliquid hic.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "30f13c84-94a9-4f7c-9a2b-2131eb03e766",
"fullname": "Sebastian Zieme",
"username": "sebastian-zieme-5f4c6eef-8b6d-48fa-849f-2fcbc6bda827",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "dc39f673-36b0-4e58-9c5e-47602f09d92a",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "15bcc132-5f72-48ae-9247-2ab493e00793",
"title": "Logo designs",
"description": "Hic inventore illum. Laborum quas asperiores. Deserunt consequuntur in.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Hane, Grant and Weissnat",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "634be4a7-12df-47a9-a1a1-e03a081817f0",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
},
{
"id": "c343ca19-ec64-45c4-94ff-cae5bc7131b7",
"type": "proposal",
"attributes": {
"summary": "Qui hic molestiae. Quam unde itaque. Sit numquam repellendus.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "30f13c84-94a9-4f7c-9a2b-2131eb03e766",
"fullname": "Sebastian Zieme",
"username": "sebastian-zieme-5f4c6eef-8b6d-48fa-849f-2fcbc6bda827",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "dc39f673-36b0-4e58-9c5e-47602f09d92a",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "0f82b0d0-5160-4d7c-809a-82111ce7cc82",
"title": "Logo designs",
"description": "Laborum quibusdam rerum. Totam aspernatur odit. Nihil sunt veritatis.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Hane, Grant and Weissnat",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "634be4a7-12df-47a9-a1a1-e03a081817f0",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
}
]
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/professionals/f1373b66-02b0-4a15-9b29-58c49272ca39/proposals" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/proposals
GET /api/v1/professionals/f1373b66-02b0-4a15-9b29-58c49272ca39/proposals
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Proposals - Get One
Getting a professional's proposal for a job
Request
curl -g "http://localhost:3000/api/v1/professionals/f42217c0-1b85-4894-a78f-d996db92856e/proposals/757091b8-6f04-4a69-a73a-7344707c8b97" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: claud_rogahn@zemlak.co" \
-H "Authorization: hCyXEkxdoyez7P57AegY" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/proposals/:id
GET /api/v1/professionals/f42217c0-1b85-4894-a78f-d996db92856e/proposals/757091b8-6f04-4a69-a73a-7344707c8b97
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "757091b8-6f04-4a69-a73a-7344707c8b97",
"type": "proposal",
"attributes": {
"summary": "Voluptates nihil voluptatibus. Maiores excepturi repellat. Et quis fugit.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "f42217c0-1b85-4894-a78f-d996db92856e",
"fullname": "Carroll Graham",
"username": "carroll-graham-f139ca9f-67a2-419f-9724-9912de58bb1c",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "f06d5e72-2ba9-44c7-b56b-0a88b2c05920",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "4ceca364-7abe-4e03-bd57-e625847028f7",
"title": "Logo designs",
"description": "Voluptas vero consequatur. Est accusantium eligendi. Laboriosam optio sunt.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Flatley, Lockman and Reynolds",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "01f0c850-f8e7-40aa-8c85-ea4940059c59",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/professionals/457e5ad1-bef6-43b2-beaa-862417f220f4/proposals/2c773ce1-c177-45c6-990c-914914bd73ec" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/proposals/:id
GET /api/v1/professionals/457e5ad1-bef6-43b2-beaa-862417f220f4/proposals/2c773ce1-c177-45c6-990c-914914bd73ec
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/professionals/dbc43db3-72c8-4a20-88b7-6530acdef1d6/proposals/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: eilene@bauch.com" \
-H "Authorization: GwsYVEs9hnakRzpq7Tkp" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/professionals/:professional_id/proposals/:id
GET /api/v1/professionals/dbc43db3-72c8-4a20-88b7-6530acdef1d6/proposals/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Proposals - Update
Successful with with valid params
Request
curl "http://localhost:3000/api/v1/professionals/511c79ed-f472-4511-918f-cf2776bade48/proposals/27a3f6ed-6905-47bb-8ff2-7d6fbd1af6d8" -d '{"proposal":{"summary":"Quas eos occaecati. Consequatur enim qui. Ratione doloribus debitis.","fee":10000}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: elliott@moen.org" \
-H "Authorization: n4QDMx7gMgkJUsuDrkuJ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:professional_id/proposals/:id
PATCH /api/v1/professionals/511c79ed-f472-4511-918f-cf2776bade48/proposals/27a3f6ed-6905-47bb-8ff2-7d6fbd1af6d8
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"Quas eos occaecati. Consequatur enim qui. Ratione doloribus debitis.","fee":10000}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "27a3f6ed-6905-47bb-8ff2-7d6fbd1af6d8",
"type": "proposal",
"attributes": {
"summary": "Quas eos occaecati. Consequatur enim qui. Ratione doloribus debitis.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$10,000",
"formated_naira_value": "₦4,700,000",
"dollar_value": 10000,
"naira_value": 4700000
},
"fee": {
"formated_dollar_value": "$10,000",
"formated_naira_value": "₦4,700,000",
"dollar_value": 10000,
"naira_value": 4700000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "511c79ed-f472-4511-918f-cf2776bade48",
"fullname": "Mauro Schowalter",
"username": "mauro-schowalter-1ff7ad57-50a2-4163-98a0-f473107ebb47",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "202f2d94-8ba5-4ff6-80d8-8f3ce6ab02f7",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "be9b0ec4-8590-445f-b35b-51e6a16e8c62",
"title": "Logo designs",
"description": "Sunt optio ipsa. Omnis aspernatur ut. Qui praesentium beatae.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Block Group",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "40094cca-d1ce-4c62-8043-33117a3f4c65",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
}
}
With invalid params
Request
curl "http://localhost:3000/api/v1/professionals/e00c8174-1763-431b-86dd-a1e4b50140d7/proposals/ad7f9f29-6334-440d-adc4-812ee970ab70" -d '{"proposal":{"summary":"","fee":10000}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: pete.harvey@ullrichgraham.io" \
-H "Authorization: staFi-p5pt3rhqZVuFwu" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/professionals/:professional_id/proposals/:id
PATCH /api/v1/professionals/e00c8174-1763-431b-86dd-a1e4b50140d7/proposals/ad7f9f29-6334-440d-adc4-812ee970ab70
Accept: application/json
Content-Type: application/json
Parameters
{"proposal":{"summary":"","fee":10000}}
| Name | Description |
|---|---|
| proposal[summary] required | What the professional is offering |
| proposal[posts] | Selected posts for the proposal |
| proposal[fee] required | Charged amount - Creator/Publisher |
| proposal[post_with_photo_fee] | Influencer Fee for posts with photos |
| proposal[post_with_carousel_fee] | Influencer Fee for post with carousel |
| proposal[post_with_video_fee] | Influencer Fee for posts with video |
| proposal[story_fee] | Influencer Fee for story |
| proposal[live_video_fee] | Influencer Fee for live video |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "ad7f9f29-6334-440d-adc4-812ee970ab70",
"type": "proposal",
"errors": [
{
"source": {
"pointer": "/data/attributes/summary"
},
"detail": "Summary can't be blank",
"title": "can't be blank"
}
]
}
Proposals - Delete
Successfully deletes a job
Request
curl "http://localhost:3000/api/v1/professionals/b0f61c7a-3b05-4622-9ca7-524fa2517612/proposals/d115b568-7fe1-4322-9e9e-cfea57556c22" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: carmine_hoppe@wolff.biz" \
-H "Authorization: ups-8cefx7ZP7fKSc9DQ" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/proposals/:id
DELETE /api/v1/professionals/b0f61c7a-3b05-4622-9ca7-524fa2517612/proposals/d115b568-7fe1-4322-9e9e-cfea57556c22
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "bacc8e93-d17c-4ad7-82bf-a3ee6f200b52",
"type": "proposal",
"attributes": {
"summary": "Qui omnis nobis. Consequatur deleniti aspernatur. Quam quos voluptas.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "b0f61c7a-3b05-4622-9ca7-524fa2517612",
"fullname": "Kenton Trantow",
"username": "kenton-trantow-530b0290-fc36-45ba-9fdd-fa0ebcace816",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "3d0b9fd7-08b3-4997-9722-7d08d27ad719",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "8abe30b8-189c-4de9-a917-f17e889f5a7c",
"title": "Logo designs",
"description": "Ea ut rerum. Cumque voluptas fugiat. Ullam non velit.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Dicki, Mohr and Braun",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "d8f1aefe-77c4-44c7-b3ee-881d2ea8c080",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
},
{
"id": "36cb0124-86ec-4109-abef-429a1eaed3dd",
"type": "proposal",
"attributes": {
"summary": "Voluptatem voluptas rerum. Autem voluptatem perferendis. Pariatur impedit qui.",
"posts": [
{
"url": "http//twurl.6786/tytu",
"post_id": "74283983749"
}
],
"status": "submitted",
"accepted_at": null,
"currency": "USD",
"accepted_by": null,
"rejected_at": null,
"rejected_by": null,
"rejection_reasons": null,
"total_proposal_amount": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"fee": {
"formated_dollar_value": "$15,000",
"formated_naira_value": "₦7,050,000",
"dollar_value": 15000,
"naira_value": 7050000
},
"story_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"live_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_photo_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_video_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"post_with_carousel_fee": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"dollar_value": 0,
"naira_value": 0
},
"submitted_at": "2021-06-09",
"professional": {
"id": "b0f61c7a-3b05-4622-9ca7-524fa2517612",
"fullname": "Kenton Trantow",
"username": "kenton-trantow-530b0290-fc36-45ba-9fdd-fa0ebcace816",
"professional_type": "creator",
"profile_image_url": "",
"avg_ratings": 0.0,
"wallet_id": "3d0b9fd7-08b3-4997-9722-7d08d27ad719",
"first_proposal": false,
"commission_eligible": true,
"commission_remaining": [
30,
"July 09, 2021"
],
"tin_exists": false,
"country_code": "US"
},
"deliverable": null,
"job": {
"id": "2d32c3fb-cd6e-4d86-9bdc-f6d9b6fa0639",
"title": "Logo designs",
"description": "Ipsa fugiat blanditiis. Facere voluptatibus hic. Amet accusantium aspernatur.",
"job_type": "creator",
"skills": [
"Graphic designs"
],
"published_at": null,
"status": "published",
"application_deadline": "2021-06-14",
"campaign_name": "Dicki, Mohr and Braun",
"campaign_hashtag": "#OhYesMember",
"campaign_keyword": "OhYesMember",
"business_wallet_id": "d8f1aefe-77c4-44c7-b3ee-881d2ea8c080",
"business_can_accept": true,
"is_acceptable": true,
"hidden_campaign_name": false,
"formatted_dates": {
"created_at": "June 09, 2021",
"start_date": "June 12, 2021",
"end_date": "June 19, 2021",
"published_at": null,
"started_at": null,
"application_deadline": "June 14, 2021"
}
},
"formatted_dates": {
"submitted_at": "June 09, 2021",
"accepted_at": null,
"rejected_at": null
},
"negotiations": {
"data": [
]
}
}
}
]
}
Business user deleting a proposal
Request
curl "http://localhost:3000/api/v1/professionals/febe9f96-e07e-4e71-91cf-4f2de27631da/proposals/9cf408f3-f0f4-44f2-bfc3-f3751d764bef" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: chi.haag@bernhard.name" \
-H "Authorization: QHM7zTrE4gbaDya2a5yL" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/proposals/:id
DELETE /api/v1/professionals/febe9f96-e07e-4e71-91cf-4f2de27631da/proposals/9cf408f3-f0f4-44f2-bfc3-f3751d764bef
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Without Authentication
Request
curl "http://localhost:3000/api/v1/professionals/7255f358-71b4-4b96-a587-993e0b259bd0/proposals/964aac98-e55e-4519-baae-9729a15c79df" -d '{}' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/professionals/:professional_id/proposals/:id
DELETE /api/v1/professionals/7255f358-71b4-4b96-a587-993e0b259bd0/proposals/964aac98-e55e-4519-baae-9729a15c79df
Accept: application/json
Content-Type: application/json
Parameters
{}
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Reviews - Get All Review for Reviewee
Getting reviews for a reviewee
Request
curl -g "http://localhost:3000/api/v1/reviews?reviewable_id=dac313ed-4ca2-4d49-85e1-ea1013f30de6" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/reviews
GET /api/v1/reviews?reviewable_id=dac313ed-4ca2-4d49-85e1-ea1013f30de6
Accept: application/json
Content-Type: application/json
Parameters
reviewable_id: dac313ed-4ca2-4d49-85e1-ea1013f30de6
| Name | Description |
|---|---|
| reviewable_id required | Professional/Business ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "e914c9c7-b8aa-4e7b-8cab-24385e5d14c6",
"type": "review",
"attributes": {
"summary": "Et et occaecati. Voluptatum necessitatibus est. Consequatur in sed.",
"ratings": 3,
"created_at": "2021-06-09T07:59:34.186Z",
"created_at_in_words": "less than a minute",
"reviewer": {
"id": "1572645e-599b-4eda-8fd0-c3850448f900",
"name": "Aurora Hoeger",
"profile_link": "aurora-hoeger-1572645e-599b-4eda-8fd0-c3850448f900",
"profile_image_url": "",
"user_type": "Business"
},
"job": {
"id": "ff5042d7-8c91-4921-8790-71e9e6b2ee73",
"title": "Logo designs",
"status": "published",
"campaign_name": "Hintz and Sons"
}
}
},
{
"id": "c4d816d1-ae6c-4d5c-a52e-97b608c4b5d9",
"type": "review",
"attributes": {
"summary": "Unde fugiat perferendis. Perferendis adipisci eligendi. Blanditiis totam deleniti.",
"ratings": 3,
"created_at": "2021-06-09T07:59:34.190Z",
"created_at_in_words": "less than a minute",
"reviewer": {
"id": "983f763e-d03f-469b-b2c6-354d515e6129",
"name": "Tiana Jones",
"profile_link": "tiana-jones-983f763e-d03f-469b-b2c6-354d515e6129",
"profile_image_url": "",
"user_type": "Business"
},
"job": {
"id": "ff5042d7-8c91-4921-8790-71e9e6b2ee73",
"title": "Logo designs",
"status": "published",
"campaign_name": "Hintz and Sons"
}
}
},
{
"id": "dbd95cd3-34c3-4b97-b9e9-69ef59ae9923",
"type": "review",
"attributes": {
"summary": "Qui modi quos. Similique sit aut. Repellat aut placeat.",
"ratings": 3,
"created_at": "2021-06-09T07:59:34.192Z",
"created_at_in_words": "less than a minute",
"reviewer": {
"id": "73cd1bc3-6f5c-464d-9f47-5d5bb910b73d",
"name": "Juan Bahringer",
"profile_link": "juan-bahringer-73cd1bc3-6f5c-464d-9f47-5d5bb910b73d",
"profile_image_url": "",
"user_type": "Business"
},
"job": null
}
}
]
}
Reviews - Create New Records
Successful business reviews professional
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"Id voluptate repellendus. Modi ullam nulla. Voluptatum pariatur quaerat.","ratings":4,"job_id":"a61bb0e0-a127-4532-8bdd-8d8b9eb2260c","reviewed_id":"25eee033-12ba-4c31-952a-f63c9d92c68a","reviewed_type":"Professional"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: shamika_lang@bashirian.com" \
-H "Authorization: sjoUsGJJWV7se1Ah52Ku" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"Id voluptate repellendus. Modi ullam nulla. Voluptatum pariatur quaerat.","ratings":4,"job_id":"a61bb0e0-a127-4532-8bdd-8d8b9eb2260c","reviewed_id":"25eee033-12ba-4c31-952a-f63c9d92c68a","reviewed_type":"Professional"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "3ff85363-50a7-4655-9742-8d6bddde4442",
"type": "review",
"attributes": {
"summary": "Id voluptate repellendus. Modi ullam nulla. Voluptatum pariatur quaerat.",
"ratings": 4,
"created_at": "2021-06-09T07:59:34.618Z",
"created_at_in_words": "less than a minute",
"reviewer": {
"id": "89f7ecd6-a211-4e40-97cd-b0fe61ccf857",
"name": "Carolyne Boyer",
"profile_link": "carolyne-boyer-89f7ecd6-a211-4e40-97cd-b0fe61ccf857",
"profile_image_url": "",
"user_type": "Business"
},
"job": {
"id": "a61bb0e0-a127-4532-8bdd-8d8b9eb2260c",
"title": "Logo designs",
"status": "published",
"campaign_name": "Marks-Kunze"
}
}
}
}
Successful professional reviews business
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"Et alias vero. Sunt adipisci maiores. Culpa dolores unde.","ratings":3,"job_id":"0d614a52-1698-45d5-9238-cff30e2a5562","reviewed_id":"d5673ddc-a661-4709-8939-489bdacda482","reviewed_type":"Business"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: elsie@halvorson.co" \
-H "Authorization: Lmk6cXhGcrNV7cF8WnyK" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"Et alias vero. Sunt adipisci maiores. Culpa dolores unde.","ratings":3,"job_id":"0d614a52-1698-45d5-9238-cff30e2a5562","reviewed_id":"d5673ddc-a661-4709-8939-489bdacda482","reviewed_type":"Business"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "e2204101-c3d4-4eb7-9cd5-8cd87a3f1465",
"type": "review",
"attributes": {
"summary": "Et alias vero. Sunt adipisci maiores. Culpa dolores unde.",
"ratings": 3,
"created_at": "2021-06-09T07:59:35.134Z",
"created_at_in_words": "less than a minute",
"reviewer": {
"id": "7a599889-860b-45bc-8fa5-4f53f2ec860e",
"name": "Damaris Kuvalis",
"profile_link": "damaris-kuvalis-7a599889-860b-45bc-8fa5-4f53f2ec860e",
"profile_image_url": "",
"user_type": "Professional"
},
"job": {
"id": "0d614a52-1698-45d5-9238-cff30e2a5562",
"title": "Logo designs",
"status": "published",
"campaign_name": "Zulauf-Kuhlman"
}
}
}
}
Failure With missing summary or ratings
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"","ratings":4,"job_id":"eb943bb8-8217-4a0b-9742-692de18eea96","reviewed_id":"1202da5c-e62b-4700-aa34-81d8ede7bc82","reviewed_type":"Professional"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lianne@hoppe.net" \
-H "Authorization: y4NnHTR_sy-SeawXZrAR" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"","ratings":4,"job_id":"eb943bb8-8217-4a0b-9742-692de18eea96","reviewed_id":"1202da5c-e62b-4700-aa34-81d8ede7bc82","reviewed_type":"Professional"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "review",
"errors": [
{
"source": {
"pointer": "/data/attributes/summary"
},
"detail": "Summary can't be blank",
"title": "can't be blank"
}
]
}
When business reviews another business
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"Ipsum sed consequuntur. Officia reiciendis placeat. Assumenda quaerat commodi.","ratings":4,"job_id":"d8a8a848-9c75-4abe-bfc6-897dd206c491","reviewed_id":"440598e1-9188-4f8f-83c7-1b30bc14205f","reviewed_type":"Business"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: sharika.lockman@nikolaus.com" \
-H "Authorization: t8o1Q5sViH4feExsKv6m" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"Ipsum sed consequuntur. Officia reiciendis placeat. Assumenda quaerat commodi.","ratings":4,"job_id":"d8a8a848-9c75-4abe-bfc6-897dd206c491","reviewed_id":"440598e1-9188-4f8f-83c7-1b30bc14205f","reviewed_type":"Business"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "review",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base You cannot review another business",
"title": "You cannot review another business"
},
{
"source": {
"pointer": "/data/attributes/Deliverable Status:"
},
"detail": "Deliverable status: You can only review when the deliverable is approved",
"title": "You can only review when the deliverable is approved"
}
]
}
When Professional reviews another professional
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"Harum itaque excepturi. A repellat numquam. Ipsum molestiae dolor.","ratings":4,"job_id":"3e1f572c-bca8-48a5-92a0-68de5e06a1d6","reviewed_id":"eee178cd-bec6-443b-9ab3-7440fc6f17f2","reviewed_type":"Professional"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: loren.lubowitz@morarmcclure.com" \
-H "Authorization: gS_McPDg_18rYVrNsoy2" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"Harum itaque excepturi. A repellat numquam. Ipsum molestiae dolor.","ratings":4,"job_id":"3e1f572c-bca8-48a5-92a0-68de5e06a1d6","reviewed_id":"eee178cd-bec6-443b-9ab3-7440fc6f17f2","reviewed_type":"Professional"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "review",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base You cannot review another professional",
"title": "You cannot review another professional"
}
]
}
Fails when deliverable is not approved
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"Quia accusantium aut. Facilis ea dolorem. Distinctio dolor deleniti.","ratings":4,"job_id":"4d41682a-1449-47ee-b569-47cd88e3f8ea","reviewed_id":"8a77f529-bcbc-43a6-88a5-d9e915db8583","reviewed_type":"Professional"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: cai_schultz@lockman.com" \
-H "Authorization: H5KHMQfs_rsQiWmMTyFK" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"Quia accusantium aut. Facilis ea dolorem. Distinctio dolor deleniti.","ratings":4,"job_id":"4d41682a-1449-47ee-b569-47cd88e3f8ea","reviewed_id":"8a77f529-bcbc-43a6-88a5-d9e915db8583","reviewed_type":"Professional"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "review",
"errors": [
{
"source": {
"pointer": "/data/attributes/Deliverable Status:"
},
"detail": "Deliverable status: You can only review when the deliverable is approved",
"title": "You can only review when the deliverable is approved"
}
]
}
With existing user's review for a job
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"Quibusdam temporibus officiis. Architecto sint fugit. Debitis nihil veniam.","ratings":4,"job_id":"3901234f-f542-4e90-83f7-7ef2defe3625","reviewed_id":"eaac5dbc-8bec-4487-a247-119e0ae94e2c","reviewed_type":"Professional"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: daniel@ritchiemedhurst.org" \
-H "Authorization: ptPDcy53zibeNCwdnH_h" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"Quibusdam temporibus officiis. Architecto sint fugit. Debitis nihil veniam.","ratings":4,"job_id":"3901234f-f542-4e90-83f7-7ef2defe3625","reviewed_id":"eaac5dbc-8bec-4487-a247-119e0ae94e2c","reviewed_type":"Professional"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "review",
"errors": [
{
"source": {
"pointer": "/data/attributes/base"
},
"detail": "Base You can only create one review per job",
"title": "You can only create one review per job"
}
]
}
Failure without authentication
Request
curl "http://localhost:3000/api/v1/reviews" -d '{"review":{"summary":"Ab consequatur laboriosam. Velit vitae rerum. Labore voluptatum cum.","ratings":4,"job_id":"2139cbe0-e1cd-421d-9382-5640c6104a31","reviewed_id":"7333400f-2c86-4979-923a-8b7bf901c336","reviewed_type":"Professional"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/reviews
POST /api/v1/reviews
Accept: application/json
Content-Type: application/json
Parameters
{"review":{"summary":"Ab consequatur laboriosam. Velit vitae rerum. Labore voluptatum cum.","ratings":4,"job_id":"2139cbe0-e1cd-421d-9382-5640c6104a31","reviewed_id":"7333400f-2c86-4979-923a-8b7bf901c336","reviewed_type":"Professional"}}
| Name | Description |
|---|---|
| review[summary] required | Reason for review |
| review[ratings] required | Number of stars rated |
| review[job_id] | Job that is being reviewed |
| review[reviewed_id] | Professional/Business ID under review |
| review[reviewed_type] | String - Professional or Business |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Subscriptions - Create
Stripe Flow for Businesses
Request
curl "http://localhost:3000/api/v1/subscriptions" -d '{"business_id":"b1765051-248d-4de0-bf39-6293f25ddd1f","plan_id":"51d634c2-a2cb-49f1-b8b3-1b98a89b666c","payment_method_id":"test_pm_5"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: shelia.homenick@pfeffer.io" \
-H "Authorization: v9_V9GcozzZQ8cUnrXvu" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/subscriptions
POST /api/v1/subscriptions
Accept: application/json
Content-Type: application/json
Parameters
{"business_id":"b1765051-248d-4de0-bf39-6293f25ddd1f","plan_id":"51d634c2-a2cb-49f1-b8b3-1b98a89b666c","payment_method_id":"test_pm_5"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
| plan_id required | ID of the plan to subscribe |
| payment_method_id | ID of tokenized stripe card |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "f884eedd-a1ce-420a-adcc-7ecb76ce9664",
"type": "subscription",
"attributes": {
"business_id": "b1765051-248d-4de0-bf39-6293f25ddd1f",
"status": "pending",
"frequency": "monthly",
"plan_id": "51d634c2-a2cb-49f1-b8b3-1b98a89b666c",
"subscription_type": "plaqad_marketplace",
"created_at": "2021-06-09",
"amount_paid": "$0.06",
"start_date": null,
"end_date": null,
"card_detail": {
"data": {
"id": "93f4a516-c961-43d2-8a1b-d56416016d52",
"type": "card_detail",
"attributes": {
"wallet_id": "340fb2e3-adf9-41f1-b210-7fe020bd0fb8",
"bin": null,
"last_four": "3155",
"brand": "visa",
"expiry_month": 2,
"expiry_year": 2022,
"country_code": "FR",
"bank": null,
"updated_at": "2021-06-09T07:59:38.103Z"
}
}
},
"transaction": {
"data": {
"id": "b5eb92be-e416-44a0-b03f-67fa679e6ab8",
"type": "transaction",
"attributes": {
"id": "b5eb92be-e416-44a0-b03f-67fa679e6ab8",
"currency": "USD",
"transaction_type": "debit",
"category": "subscription",
"payment_method": "card",
"status": "pending",
"payment_reference_code": "test_su_6",
"wallet_id": null,
"customer_id": "b1765051-248d-4de0-bf39-6293f25ddd1f",
"customer_type": "Business",
"job_id": null,
"amount": "-$29",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
}
}
}
}
}
Stripe Flow for Professionals
Request
curl "http://localhost:3000/api/v1/subscriptions" -d '{"professional_id":"334e1636-9698-4b50-9c48-5241c9a0fb44","plan_id":"4a2665bb-dc56-477d-a046-e32ebd4e967e","payment_method_id":"test_pm_9"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: clotilde.torp@mckenziejohnston.biz" \
-H "Authorization: X_su4SpJVT_Pc5LGWRy9" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/subscriptions
POST /api/v1/subscriptions
Accept: application/json
Content-Type: application/json
Parameters
{"professional_id":"334e1636-9698-4b50-9c48-5241c9a0fb44","plan_id":"4a2665bb-dc56-477d-a046-e32ebd4e967e","payment_method_id":"test_pm_9"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
| plan_id required | ID of the plan to subscribe |
| payment_method_id | ID of tokenized stripe card |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "edf1626c-95f8-42b0-b5ce-b1f8dc29d1bd",
"type": "subscription",
"attributes": {
"business_id": null,
"status": "pending",
"frequency": "monthly",
"plan_id": "6fdd9fab-2255-49af-b6bb-eb6ef641b65e",
"subscription_type": "plaqad_marketplace",
"created_at": "2021-06-09",
"amount_paid": "$0.06",
"start_date": null,
"end_date": null,
"card_detail": {
"data": {
"id": "d8d454cf-1227-4e61-9eac-fc2249bdd942",
"type": "card_detail",
"attributes": {
"wallet_id": "5fac7cef-a4e5-4594-8ccb-f5b56a3b686a",
"bin": null,
"last_four": "3155",
"brand": "visa",
"expiry_month": 2,
"expiry_year": 2022,
"country_code": "FR",
"bank": null,
"updated_at": "2021-06-09T07:59:38.378Z"
}
}
},
"transaction": {
"data": {
"id": "cbf2baff-0c6c-4ecc-a595-3b830a88c564",
"type": "transaction",
"attributes": {
"id": "cbf2baff-0c6c-4ecc-a595-3b830a88c564",
"currency": "USD",
"transaction_type": "debit",
"category": "subscription",
"payment_method": "card",
"status": "pending",
"payment_reference_code": "test_su_10",
"wallet_id": null,
"customer_id": "334e1636-9698-4b50-9c48-5241c9a0fb44",
"customer_type": "Professional",
"job_id": null,
"amount": "-$29",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
}
}
}
}
}
Subscriptions - Create IQ Trial
Plaqad IQ Trial for Businesses
Request
curl "http://localhost:3000/api/v1/subscriptions/create_iq_trial" -d '{"business_id":"3616237f-2c64-4b7a-be4f-16459682bec0"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: hong@durgandouglas.com" \
-H "Authorization: XsxNsJNm24XXp1xayycU" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/subscriptions/create_iq_trial
POST /api/v1/subscriptions/create_iq_trial
Accept: application/json
Content-Type: application/json
Parameters
{"business_id":"3616237f-2c64-4b7a-be4f-16459682bec0"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "d0575576-9434-41e5-b955-820748273cf4",
"type": "subscription",
"attributes": {
"business_id": "3616237f-2c64-4b7a-be4f-16459682bec0",
"status": "active",
"frequency": "trial",
"plan_id": "7e74c06b-cdd5-458e-9792-66df0f027541",
"subscription_type": "plaqad_iq",
"created_at": "2021-06-09",
"amount_paid": "$0",
"start_date": "June 09, 2021",
"end_date": "June 23, 2021",
"card_detail": {
"data": null
},
"transaction": null
}
}
}
Plaqad IQ Trial for Professionals
Request
curl "http://localhost:3000/api/v1/subscriptions/create_iq_trial" -d '{"professional_id":"e1600825-e6af-4057-9e57-614247476d99"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ray@paucekrippin.biz" \
-H "Authorization: V9hwf8K-q-7JE5gd2KN1" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/subscriptions/create_iq_trial
POST /api/v1/subscriptions/create_iq_trial
Accept: application/json
Content-Type: application/json
Parameters
{"professional_id":"e1600825-e6af-4057-9e57-614247476d99"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "5f9c3be6-d39d-4b72-9692-23eee42efab8",
"type": "subscription",
"attributes": {
"business_id": null,
"status": "active",
"frequency": "trial",
"plan_id": "d4253d61-710f-4965-898f-0457f5033c82",
"subscription_type": "plaqad_iq",
"created_at": "2021-06-09",
"amount_paid": "$0",
"start_date": "June 09, 2021",
"end_date": "June 23, 2021",
"card_detail": {
"data": null
},
"transaction": null
}
}
}
Subscriptions - Create Paystack flow
Paystack Flow for Businesses
Request
curl "http://localhost:3000/api/v1/subscriptions/paystack_transaction" -d '{"business_id":"05da0861-399c-478b-8763-6c22b3ae13f0","plan_id":"df1417d4-3418-46b4-a7fe-e3f76dec3b0b"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: simon.weinat@wuckerthudson.info" \
-H "Authorization: F6yAdxnS9ZBvKiewrXrz" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/subscriptions/paystack_transaction
POST /api/v1/subscriptions/paystack_transaction
Accept: application/json
Content-Type: application/json
Parameters
{"business_id":"05da0861-399c-478b-8763-6c22b3ae13f0","plan_id":"df1417d4-3418-46b4-a7fe-e3f76dec3b0b"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
| plan_id required | ID of the plan to subscribe |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"status": true,
"message": "Authorization URL created",
"data": {
"authorization_url": "https://checkout.paystack.com/0peioxfhpn",
"access_code": "0peioxfhpn",
"reference": "7PVGX8MEk85tgeEpVDtD"
}
}
}
Paystack Flow for Professionals
Request
curl "http://localhost:3000/api/v1/subscriptions/paystack_transaction" -d '{"professional_id":"6eb59ad8-868b-4946-bd7b-f5ab8c0b89e4","plan_id":"a9480d32-f638-4a92-99bc-a28b8a2310e8"}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ruthie@fritsch.com" \
-H "Authorization: nCK7q8ikJUyTpZDz_biC" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/subscriptions/paystack_transaction
POST /api/v1/subscriptions/paystack_transaction
Accept: application/json
Content-Type: application/json
Parameters
{"professional_id":"6eb59ad8-868b-4946-bd7b-f5ab8c0b89e4","plan_id":"a9480d32-f638-4a92-99bc-a28b8a2310e8"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
| plan_id required | ID of the plan to subscribe |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"status": true,
"message": "Authorization URL created",
"data": {
"authorization_url": "https://checkout.paystack.com/0peioxfhpn",
"access_code": "0peioxfhpn",
"reference": "7PVGX8MEk85tgeEpVDtD"
}
}
}
Subscriptions - Cancel Subscriptions
Cancel Plaqad Marketplace Sbuscription
Request
curl "http://localhost:3000/api/v1/subscriptions/20eb7491-6e3f-41fa-aeb5-44ff2a7de98c/cancel" -d '{"business_id":"24274c29-392f-4b09-841b-b09bc646f4cc"}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: robena@grady.org" \
-H "Authorization: dwsjdsUqmNKyVJWgVmHw" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/subscriptions/:subscription_id/cancel
PATCH /api/v1/subscriptions/20eb7491-6e3f-41fa-aeb5-44ff2a7de98c/cancel
Accept: application/json
Content-Type: application/json
Parameters
{"business_id":"24274c29-392f-4b09-841b-b09bc646f4cc"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
| subscription_id required | Subscription ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "d1632afd-9bab-45bc-8662-acd672461630",
"type": "wallet",
"attributes": {
"currency": "USD",
"funding_source": "Stripe",
"owner_id": "24274c29-392f-4b09-841b-b09bc646f4cc",
"owner_type": "Business",
"created_at": "2021-06-09T07:59:39.032Z",
"bank_account_name": null,
"bank_account_number": null,
"bank_code": null,
"payout_active": false,
"stripe_account_id": null,
"funding_source_customer_id": "test_cus_1",
"balance": "$0",
"balance_value": 0,
"total_amount_withdrawn_lifetime": "$0",
"total_amount_withdrawn_today": "$0",
"last_withdrawn_amount": "$0",
"last_withdrawn_date": null,
"can_withraw": false,
"card_detail": {
"data": null
},
"transactions": [
{
"id": "985eaeb7-c261-4a02-8e1c-08b3342147e8",
"currency": "USD",
"transaction_type": "debit",
"category": "subscription",
"payment_method": "card",
"status": "pending",
"payment_reference_code": "test_su_3",
"wallet_id": null,
"customer_id": "24274c29-392f-4b09-841b-b09bc646f4cc",
"customer_type": "Business",
"job_id": null,
"amount": "-$29",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
],
"marketplace_subscription": {
"subscription_id": "d4b0ebb6-64f6-4836-ad14-2e14fed9fa22",
"plan_id": "bffa2160-3bc0-45d2-bebd-387303063ea0",
"end_date": null,
"plan_name": "Basic",
"plan_data": {
"id": "bffa2160-3bc0-45d2-bebd-387303063ea0",
"funding_source_plan_id": null,
"title": "Basic",
"description": "Free plan",
"amount": 0,
"currency": "USD",
"frequency": "free",
"number": null,
"product_type": "plaqad_marketplace",
"allowed_proposals_count": 10,
"allowed_campaigns_count": 2,
"allowed_posts_count": 0,
"allowed_reports_count": 0,
"created_at": "2021-06-09T07:59:39.018Z",
"updated_at": "2021-06-09T07:59:39.018Z",
"allowed_social_account_count": null,
"allowed_keywords_or_hashtags_count": null
}
},
"plaqad_iq_subscription": {
"subscription_id": null,
"plan_id": null,
"end_date": null,
"plan_name": null,
"plan_data": null
},
"marketplace_subscription_count": 3,
"plaqad_iq_subscription_count": 0
}
}
}
Cancel Plaqad IQ subscription
Request
curl "http://localhost:3000/api/v1/subscriptions/5641d611-fc21-4210-8951-dd933f972c9f/cancel" -d '{"professional_id":"59c48480-086e-4f4d-8f1a-57424650ffbf"}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lorena.heidenreich@yundtschneider.biz" \
-H "Authorization: 3-tJ4zfskVGjtBsgsssB" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/subscriptions/:subscription_id/cancel
PATCH /api/v1/subscriptions/5641d611-fc21-4210-8951-dd933f972c9f/cancel
Accept: application/json
Content-Type: application/json
Parameters
{"professional_id":"59c48480-086e-4f4d-8f1a-57424650ffbf"}
| Name | Description |
|---|---|
| business_id | ID of associated business |
| professional_id | ID of associated professional |
| subscription_id required | Subscription ID |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "d9649502-4aa3-4140-998e-119bbc30ba0b",
"type": "wallet",
"attributes": {
"currency": "USD",
"funding_source": "Stripe",
"owner_id": "59c48480-086e-4f4d-8f1a-57424650ffbf",
"owner_type": "Professional",
"created_at": "2021-06-09T07:59:39.177Z",
"bank_account_name": null,
"bank_account_number": null,
"bank_code": null,
"payout_active": false,
"stripe_account_id": null,
"funding_source_customer_id": "test_cus_5",
"balance": "$0",
"balance_value": 0,
"total_amount_withdrawn_lifetime": "$0",
"total_amount_withdrawn_today": "$0",
"last_withdrawn_amount": "$0",
"last_withdrawn_date": null,
"can_withraw": false,
"card_detail": {
"data": null
},
"transactions": [
{
"id": "c67fba8d-74df-4abb-bd75-cceee9128841",
"currency": "USD",
"transaction_type": "debit",
"category": "subscription",
"payment_method": "card",
"status": "pending",
"payment_reference_code": "test_su_7",
"wallet_id": null,
"customer_id": "59c48480-086e-4f4d-8f1a-57424650ffbf",
"customer_type": "Professional",
"job_id": null,
"amount": "-$348",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
],
"marketplace_subscription": null,
"plaqad_iq_subscription": {
"subscription_id": null,
"plan_id": null,
"end_date": null,
"plan_name": null,
"plan_data": null
},
"marketplace_subscription_count": 0,
"plaqad_iq_subscription_count": 1
}
}
}
Tax - Get all
Getting list of user taxes
Request
curl -g "http://localhost:3000/api/v1/user/taxes" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: crystle.davis@osinski.org" \
-H "Authorization: T5kpLbJLUp-AfFyRzxaL" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/user/taxes
GET /api/v1/user/taxes
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "7ba95b48-8141-4a0e-a494-9ae87eca4936",
"type": "tax",
"attributes": {
"tax_amount": 0.55,
"created_at": "June 09, 2021 07:59",
"currency": "NGN",
"job": {
"id": "a4f51f38-8550-4bf5-a957-0bb4a7a1e59e",
"title": "Logo designs",
"description": "Amet enim odit. Magnam natus placeat. Consequatur ut deleniti.",
"job_type": "creator"
},
"invoice": {
"id": "108dd8a2-7932-414e-874b-9e82b52da3ba",
"proposal_amount_ngn": 5000.0,
"service_charge_ngn": 50.0,
"proposal_amount_usd": 13.0,
"service_charge_usd": 0.13
}
}
}
]
}
Users::Confirmations - Generate token
Successfully generates confirmation link
Request
curl "http://localhost:3000/api/v1/users/confirmation" -d '{"user":{"email":"grover@skiles.com"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/confirmation
POST /api/v1/users/confirmation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"grover@skiles.com"}}
| Name | Description |
|---|---|
| user[email] required | User email |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"message": "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
}
}
With wrong email
Request
curl "http://localhost:3000/api/v1/users/confirmation" -d '{"user":{"email":"something@noexist.com"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/confirmation
POST /api/v1/users/confirmation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"something@noexist.com"}}
| Name | Description |
|---|---|
| user[email] required | User email |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"message": "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
}
}
Users::Confirmations - Confirm email
Successfully confirms an email
Request
curl "http://localhost:3000/api/v1/users/confirmation" -d '{"confirmation_token":"CjBeWzHsyNPnkp2aRdmy"}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/confirmation
PATCH /api/v1/users/confirmation
Accept: application/json
Content-Type: application/json
Parameters
{"confirmation_token":"CjBeWzHsyNPnkp2aRdmy"}
| Name | Description |
|---|---|
| confirmation_token required | confirmation token |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "fca467cf-46cf-4e68-bd6b-c535c0964af6",
"type": "authenticated_user",
"attributes": {
"fullname": "Sueann Boehm",
"username": "sueann-boehm-fca467cf-46cf-4e68-bd6b-c535c0964af6",
"email": "paz.witting@schultz.io",
"firstname": "Sueann",
"lastname": "Boehm",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "SNH1qQzXsNojTsiP-R-z",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": null,
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": null,
"profile_image_url": ""
}
}
}
With invalid token
Request
curl "http://localhost:3000/api/v1/users/confirmation" -d '{"confirmation_token":"Thgdeybhd23"}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/confirmation
PATCH /api/v1/users/confirmation
Accept: application/json
Content-Type: application/json
Parameters
{"confirmation_token":"Thgdeybhd23"}
| Name | Description |
|---|---|
| confirmation_token required | confirmation token |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"data": {
"errors": {
"detail": "Invalid confirmation token"
}
}
}
Invitations - Send Invitations
Successfully sends a new user an inviation
Request
curl "http://localhost:3000/api/v1/users/invitation" -d '{"user":{"email":"emy@gmail.com"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: yee@waelchi.net" \
-H "Authorization: Kgvm_pcsdp1tjUPZ7Gam" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/invitation
POST /api/v1/users/invitation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"emy@gmail.com"}}
| Name | Description |
|---|---|
| user[email] required | Email of user to be invited (existing or new |
Response
Content-Type: application/json
201 Created
When user invites an existing user
Request
curl "http://localhost:3000/api/v1/users/invitation" -d '{"user":{"email":"brian.stamm@heidenreichstrosin.io"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: illa@wiegand.org" \
-H "Authorization: de5FzJjbQN5b1hV_9H1M" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/invitation
POST /api/v1/users/invitation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"brian.stamm@heidenreichstrosin.io"}}
| Name | Description |
|---|---|
| user[email] required | Email of user to be invited (existing or new |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "b56e0c4b-7bd4-49f1-9ad6-013cbdf475a5",
"type": "user",
"errors": [
{
"source": {
"pointer": "/data/attributes/email"
},
"detail": "Email address brian.stamm@heidenreichstrosin.io already has a Plaqad account",
"title": "address brian.stamm@heidenreichstrosin.io already has a Plaqad account"
}
]
}
When user invites themselves
Request
curl "http://localhost:3000/api/v1/users/invitation" -d '{"user":{"email":"modesto_hartmann@gottlieb.name"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: modesto_hartmann@gottlieb.name" \
-H "Authorization: TXJZTsx7fbJn-ynJhxyA" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/invitation
POST /api/v1/users/invitation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"modesto_hartmann@gottlieb.name"}}
| Name | Description |
|---|---|
| user[email] required | Email of user to be invited (existing or new |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "93a69e8c-a3af-4dbe-8cc4-e3c5475dcd5e",
"type": "user",
"errors": [
{
"source": {
"pointer": "/data/attributes/email"
},
"detail": "Email address modesto_hartmann@gottlieb.name already has a Plaqad account",
"title": "address modesto_hartmann@gottlieb.name already has a Plaqad account"
}
]
}
Without authentication
Request
curl "http://localhost:3000/api/v1/users/invitation" -d '{"user":{"email":"emy@gmail.com"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/invitation
POST /api/v1/users/invitation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"emy@gmail.com"}}
| Name | Description |
|---|---|
| user[email] required | Email of user to be invited (existing or new |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Invitations - Accept Invitations
With valid token
Request
curl "http://localhost:3000/api/v1/users/invitation" -d '{"user":{"invitation_token":"q-aasepYsaWDw-Mzx2Ym","firstname":"James","lastname":"Emily","password":"arigatou","password_confirmation":"arigatou"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/invitation
PATCH /api/v1/users/invitation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"invitation_token":"q-aasepYsaWDw-Mzx2Ym","firstname":"James","lastname":"Emily","password":"arigatou","password_confirmation":"arigatou"}}
| Name | Description |
|---|---|
| user[invitation_token] required | Invitation token sent to user |
| user[firstname] | First name of the user |
| user[lastname] | Last name of the user |
| user[password] required | Password for new user |
| user[password_confirmation] required | Password for new user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "8f67703d-b42d-4367-8aef-79abbecb40d8",
"type": "authenticated_user",
"attributes": {
"fullname": "James Emily",
"username": "-8f67703d-b42d-4367-8aef-79abbecb40d8",
"email": "emy@gmail.com",
"firstname": "James",
"lastname": "Emily",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "2bNiNy3ZzDojEqRc1Skz",
"currency": "USD",
"country_code": null,
"role": "member",
"wallet_id": "5f0ea484-e85c-41b5-b14a-5d4972d15704",
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": "376d5950-6594-4bc7-a71e-f9b0dc30bc3e",
"marketplace_plan_id": "62426edd-b6bf-4530-a334-593bb9cc5a46",
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": {
"data": {
"id": "a602c50f-f0fe-45bf-809c-e63e4e44840f",
"type": "business",
"attributes": {
"name": "O'Hara, Metz and Shanahan",
"description": "Aut voluptatem iure. Qui consequuntur sapiente. Nobis aut aut.",
"phone_number": null,
"website": "huel.org",
"address": null,
"industry": null,
"company_size": null,
"business_type": null,
"status": "active",
"logo_url": null,
"avg_ratings": 0.0,
"has_active_marketplace_subscription": true,
"marketplace_subscription_id": "376d5950-6594-4bc7-a71e-f9b0dc30bc3e",
"has_active_plaqad_iq_subscription": false,
"plaqad_iq_subscription_id": null,
"can_create_campaign": true,
"can_accept_proposal": true,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"profile_image_url": ""
}
}
}
Without Password
Request
curl "http://localhost:3000/api/v1/users/invitation" -d '{"user":{"invitation_token":"M_EcPQh1ZyE8zNemcevM"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/invitation
PATCH /api/v1/users/invitation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"invitation_token":"M_EcPQh1ZyE8zNemcevM"}}
| Name | Description |
|---|---|
| user[invitation_token] required | Invitation token sent to user |
| user[firstname] | First name of the user |
| user[lastname] | Last name of the user |
| user[password] required | Password for new user |
| user[password_confirmation] required | Password for new user |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "38ccdbb3-3251-4594-a1de-d1eb42319041",
"type": "user",
"errors": [
{
"source": {
"pointer": "/data/attributes/password"
},
"detail": "Password can't be blank",
"title": "can't be blank"
}
]
}
With invalid token
Request
curl "http://localhost:3000/api/v1/users/invitation" -d '{"user":{"invitation_token":"67rfd45uygv","password":"arigatou","password_confirmation":"arigatou"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/invitation
PATCH /api/v1/users/invitation
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"invitation_token":"67rfd45uygv","password":"arigatou","password_confirmation":"arigatou"}}
| Name | Description |
|---|---|
| user[invitation_token] required | Invitation token sent to user |
| user[firstname] | First name of the user |
| user[lastname] | Last name of the user |
| user[password] required | Password for new user |
| user[password_confirmation] required | Password for new user |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "user",
"errors": [
{
"source": {
"pointer": "/data/attributes/invitation_token"
},
"detail": "Invitation_token is invalid",
"title": "is invalid"
}
]
}
Invitations - Cancel Invitation
With valid token
Request
curl -g "http://localhost:3000/api/v1/users/invitation/remove?invitation_token=R5NBMsyMV8E-Fyq6k8FD" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/invitation/remove
GET /api/v1/users/invitation/remove?invitation_token=R5NBMsyMV8E-Fyq6k8FD
Accept: application/json
Content-Type: application/json
Parameters
invitation_token: R5NBMsyMV8E-Fyq6k8FD
| Name | Description |
|---|---|
| invitation_token required | Invitation token sent to user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"message": "Invitation has been cancelled"
}
}
With invalid token
Request
curl -g "http://localhost:3000/api/v1/users/invitation/remove?invitation_token=yi7i6r5e5xdw34e4" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/invitation/remove
GET /api/v1/users/invitation/remove?invitation_token=yi7i6r5e5xdw34e4
Accept: application/json
Content-Type: application/json
Parameters
invitation_token: yi7i6r5e5xdw34e4
| Name | Description |
|---|---|
| invitation_token required | Invitation token sent to user |
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/">redirected</a>.</body></html>
Users::OmniauthCallbacks - Facebook
Facebook user - successfully creates account/logs user in
Request
curl -g "http://localhost:3000/api/v1/users/auth/facebook/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/facebook/callback
GET /api/v1/users/auth/facebook/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/authenticate?oauth_token=dd4c887cf131d1e9b33442383759dccc6091969dad272da3dc93f3a27bce5f63&origin=facebook&response_type=success">redirected</a>.</body></html>
Users::OmniauthCallbacks - Twitter
Twitter user - successfully creates account/logs user in
Request
curl -g "http://localhost:3000/api/v1/users/auth/twitter/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/twitter/callback
GET /api/v1/users/auth/twitter/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/authenticate?oauth_token=3f490d12895eada6a63733a015afd9014af09c78a53187981a699d28ea97cb4f&origin=twitter&response_type=success">redirected</a>.</body></html>
Users::OmniauthCallbacks - Google
Google user - successfully creates account/logs user in
Request
curl -g "http://localhost:3000/api/v1/users/auth/google/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/google/callback
GET /api/v1/users/auth/google/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/authenticate?oauth_token=e19e8cd21e65ed79788eca2f6510331d93f8182624e8799847f41b2cc775cf06&origin=google&response_type=success">redirected</a>.</body></html>
Users::OmniauthCallbacks - Linkedin
Linkedin user - successfully creates account/logs user in
Request
curl -g "http://localhost:3000/api/v1/users/auth/linkedin/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/linkedin/callback
GET /api/v1/users/auth/linkedin/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/authenticate?oauth_token=d15f04de535cb9a3147d641961e740787cb5f6ee28144f8dc94b04d69a4f9aa9&origin=linkedin&response_type=success">redirected</a>.</body></html>
Users::OmniauthCallbacks - Instagram
Instagram user - successfully creates account/logs user in
Request
curl -g "http://localhost:3000/api/v1/users/auth/instagram/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/instagram/callback
GET /api/v1/users/auth/instagram/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/connect?origin=instagram&response_type=success">redirected</a>.</body></html>
With no facebook page
Request
curl -g "http://localhost:3000/api/v1/users/auth/instagram/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/instagram/callback
GET /api/v1/users/auth/instagram/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/connect?error_message=Instagram+error%3A+You+need+to+select+at+least+one+facebook+page&origin=instagram&response_type=error&status=unauthorized">redirected</a>.</body></html>
With no linked instagram account
Request
curl -g "http://localhost:3000/api/v1/users/auth/instagram/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/instagram/callback
GET /api/v1/users/auth/instagram/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/connect?error_message=Instagram+error%3A+You+need+to+select+at+least+one+instagram+account&origin=instagram&response_type=error&status=unauthorized">redirected</a>.</body></html>
Users::OmniauthCallbacks - Youtube
Youtube user - successfully creates account/logs user in
Request
curl -g "http://localhost:3000/api/v1/users/auth/youtube/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/youtube/callback
GET /api/v1/users/auth/youtube/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/connect?origin=youtube&response_type=success">redirected</a>.</body></html>
Youtube account without a linked channel
Request
curl -g "http://localhost:3000/api/v1/users/auth/youtube/callback" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/youtube/callback
GET /api/v1/users/auth/youtube/callback
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: text/html; charset=utf-8
302 Found
<html><body>You are being <a href="http://example.org/connect?error_message=Youtube+error%3A+No+channels+linked+to+this+account&origin=youtube&response_type=error&status=unauthorized">redirected</a>.</body></html>
Users::OmniauthCallbacks - Failure
With invalid credentials
Request
curl -g "http://localhost:3000/api/v1/users/auth/failure" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/auth/failure
GET /api/v1/users/auth/failure
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "Something went wrong. Please try again"
}
}
}
Users::Passwords - Generate Reset Link
Successfully generates reset link
Request
curl "http://localhost:3000/api/v1/users/password" -d '{"user":{"email":"jackson@johnston.io"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/password
POST /api/v1/users/password
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"jackson@johnston.io"}}
| Name | Description |
|---|---|
| user[email] required | User email |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"message": "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
}
}
With wrong email
Request
curl "http://localhost:3000/api/v1/users/password" -d '{"user":{"email":"something@noexist.com"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/password
POST /api/v1/users/password
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"something@noexist.com"}}
| Name | Description |
|---|---|
| user[email] required | User email |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"message": "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
}
}
With missing email params
Request
curl "http://localhost:3000/api/v1/users/password" -d '{"user":{"password":"nitzsche"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/password
POST /api/v1/users/password
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"password":"nitzsche"}}
| Name | Description |
|---|---|
| user[email] required | User email |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "Email not present"
}
}
}
Users::Passwords - Update Password
Successfully changes user's password
Request
curl "http://localhost:3000/api/v1/users/password" -d '{"user":{"reset_password_token":"ej6bi7K1yVu1amM4uecj","password":"new-password","password_confirmation":"new-password"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/password
PATCH /api/v1/users/password
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"reset_password_token":"ej6bi7K1yVu1amM4uecj","password":"new-password","password_confirmation":"new-password"}}
| Name | Description |
|---|---|
| user[reset_password_token] required | User reset password token |
| user[password] required | User password |
| user[password_confirmation] required | User password confirmation |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "a4bbdc3b-a149-42d8-824d-695ef9918225",
"type": "authenticated_user",
"attributes": {
"fullname": "Evan Mohr",
"username": "evan-mohr-a4bbdc3b-a149-42d8-824d-695ef9918225",
"email": "reita@carroll.io",
"firstname": "Evan",
"lastname": "Mohr",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "PigjbkzJF9LvxGggPuQs",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": null,
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": null,
"profile_image_url": ""
}
}
}
With very short password
Request
curl "http://localhost:3000/api/v1/users/password" -d '{"user":{"reset_password_token":"WGox_5F7yLxgfdx1CgCw","password":"new","password_confirmation":"new"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/password
PATCH /api/v1/users/password
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"reset_password_token":"WGox_5F7yLxgfdx1CgCw","password":"new","password_confirmation":"new"}}
| Name | Description |
|---|---|
| user[reset_password_token] required | User reset password token |
| user[password] required | User password |
| user[password_confirmation] required | User password confirmation |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "2e8071ef-77ec-4c24-bfbd-eb780860dc7a",
"type": "user",
"errors": [
{
"source": {
"pointer": "/data/attributes/password"
},
"detail": "Password is too short (minimum is 6 characters)",
"title": "is too short (minimum is 6 characters)"
}
]
}
Users::Registrations - Create User Account
Successfully creates account for new user
Request
curl "http://localhost:3000/api/v1/users" -d '{"user":{"email":"bless.johnson@example.com","password":"334wersW","password_confirmation":"334wersW"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users
POST /api/v1/users
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"bless.johnson@example.com","password":"334wersW","password_confirmation":"334wersW"}}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
| user[password_confirmation] required | User password confirmation |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "6934f516-d6cf-49c2-a408-203cdd086a92",
"type": "authenticated_user",
"attributes": {
"fullname": null,
"username": "-6934f516-d6cf-49c2-a408-203cdd086a92",
"email": "bless.johnson@example.com",
"firstname": null,
"lastname": null,
"bio": null,
"location": null,
"email_status": "unconfirmed",
"authentication_token": "WEfrkAkxnM8CuZos63ek",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": null,
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": null,
"profile_image_url": ""
}
}
}
When user already exists
Request
curl "http://localhost:3000/api/v1/users" -d '{"user":{"email":"bless.johnson@example.com","password":"334wersW","password_confirmation":"334wersW"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users
POST /api/v1/users
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"bless.johnson@example.com","password":"334wersW","password_confirmation":"334wersW"}}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
| user[password_confirmation] required | User password confirmation |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "user",
"errors": [
{
"source": {
"pointer": "/data/attributes/email"
},
"detail": "Email address bless.johnson@example.com already has a Plaqad account",
"title": "address bless.johnson@example.com already has a Plaqad account"
}
]
}
With incorrect sign up params
Request
curl "http://localhost:3000/api/v1/users" -d '{}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users
POST /api/v1/users
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
| user[password_confirmation] required | User password confirmation |
Response
Content-Type: application/json; charset=utf-8
400 Bad Request
{
"data": {
"errors": {
"detail": "Missing Credentials"
}
}
}
Users::Sessions - Login
Successfully logs in a confirmed user account
Request
curl "http://localhost:3000/api/v1/users/login" -d '{"user":{"email":"deana@howevolkman.biz","password":"nitzsche"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/login
POST /api/v1/users/login
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"deana@howevolkman.biz","password":"nitzsche"}}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "9695171e-9faa-4653-9515-24d0f9b2292d",
"type": "authenticated_user",
"attributes": {
"fullname": "Faustino Koepp",
"username": "faustino-koepp-9695171e-9faa-4653-9515-24d0f9b2292d",
"email": "deana@howevolkman.biz",
"firstname": "Faustino",
"lastname": "Koepp",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "coJbZz_847q-iAeQXRjx",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": null,
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": null,
"profile_image_url": ""
}
}
}
With incorrect sign in params
Request
curl "http://localhost:3000/api/v1/users/login" -d '{}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/login
POST /api/v1/users/login
Accept: application/json
Content-Type: application/json
Parameters
{}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
Response
Content-Type: application/json; charset=utf-8
400 Bad Request
{
"data": {
"errors": {
"detail": "Missing Credentials"
}
}
}
With unconfirmed user account
Request
curl "http://localhost:3000/api/v1/users/login" -d '{"user":{"email":"wilfredo.schowalter@schowalternienow.net","password":"nitzsche"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/login
POST /api/v1/users/login
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"wilfredo.schowalter@schowalternienow.net","password":"nitzsche"}}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "Please confirm your email address before continuing"
}
}
}
With wrong email
Request
curl "http://localhost:3000/api/v1/users/login" -d '{"user":{"email":"something@noexist.com"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/login
POST /api/v1/users/login
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"something@noexist.com"}}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "This account does not exist"
}
}
}
With wrong password
Request
curl "http://localhost:3000/api/v1/users/login" -d '{"user":{"email":"tommye@kodietrich.info","password":"tryagain"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/users/login
POST /api/v1/users/login
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":"tommye@kodietrich.info","password":"tryagain"}}
| Name | Description |
|---|---|
| user[email] required | User email |
| user[password] required | User password |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "Invalid password"
}
}
}
Users::Sessions - Logout
Suucessfully logs out a user
Request
curl "http://localhost:3000/api/v1/users/sign_out" -d '' -X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
DELETE /api/v1/users/sign_out
DELETE /api/v1/users/sign_out
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
204 No Content
Wallets - Get One
Getting a business's wallet
Request
curl -g "http://localhost:3000/api/v1/wallets/3f6aecad-5a36-4333-b85c-044c007c1228" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: trenton_jakubowski@armstrongborer.biz" \
-H "Authorization: 8m6AHU2_4_4d8hzuPvaD" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id
GET /api/v1/wallets/3f6aecad-5a36-4333-b85c-044c007c1228
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "3f6aecad-5a36-4333-b85c-044c007c1228",
"type": "wallet",
"attributes": {
"currency": "USD",
"funding_source": "Stripe",
"owner_id": "81ff8c33-1e4a-40d2-884f-76245f253766",
"owner_type": "Business",
"created_at": "2021-06-09T07:59:42.219Z",
"bank_account_name": null,
"bank_account_number": null,
"bank_code": null,
"payout_active": false,
"stripe_account_id": null,
"funding_source_customer_id": "test_cus_1",
"balance": "$0",
"balance_value": 0,
"total_amount_withdrawn_lifetime": "$0",
"total_amount_withdrawn_today": "$0",
"last_withdrawn_amount": "$0",
"last_withdrawn_date": null,
"can_withraw": false,
"card_detail": {
"data": null
},
"transactions": [
{
"id": "0b10ae1d-cc13-4134-af1c-6d81e11973b0",
"currency": "USD",
"transaction_type": "debit",
"category": "subscription",
"payment_method": "card",
"status": "pending",
"payment_reference_code": "test_su_3",
"wallet_id": null,
"customer_id": "81ff8c33-1e4a-40d2-884f-76245f253766",
"customer_type": "Business",
"job_id": null,
"amount": "-$29",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
],
"marketplace_subscription": {
"subscription_id": "bb423c66-a6da-40dc-bb22-7c0ae27e75e7",
"plan_id": "ac403d36-2140-4548-8c27-fc2c2beabad4",
"end_date": null,
"plan_name": "Starter monthly",
"plan_data": {
"id": "ac403d36-2140-4548-8c27-fc2c2beabad4",
"funding_source_plan_id": "priHysj",
"title": "Starter monthly",
"description": "For professionals & small organizations",
"amount": 29,
"currency": "USD",
"frequency": "monthly",
"number": null,
"product_type": "plaqad_marketplace",
"allowed_proposals_count": 50,
"allowed_campaigns_count": 5,
"allowed_posts_count": 3000,
"allowed_reports_count": 5,
"created_at": "2021-06-09T07:59:42.207Z",
"updated_at": "2021-06-09T07:59:42.207Z",
"allowed_social_account_count": null,
"allowed_keywords_or_hashtags_count": null
}
},
"plaqad_iq_subscription": {
"subscription_id": null,
"plan_id": null,
"end_date": null,
"plan_name": null,
"plan_data": null
},
"marketplace_subscription_count": 2,
"plaqad_iq_subscription_count": 0
}
}
}
Getting a professional's wallet
Request
curl -g "http://localhost:3000/api/v1/wallets/6f3b9784-e8ef-4f0c-9186-912b548652a8" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: alfonzo@windler.info" \
-H "Authorization: r1kzXMzWAY_9SxFCCn9j" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id
GET /api/v1/wallets/6f3b9784-e8ef-4f0c-9186-912b548652a8
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "6f3b9784-e8ef-4f0c-9186-912b548652a8",
"type": "wallet",
"attributes": {
"currency": "USD",
"funding_source": "Stripe",
"owner_id": "c4a6f295-897f-42ac-a1b5-c0dcbb7f85cf",
"owner_type": "Professional",
"created_at": "2021-06-09T07:59:42.539Z",
"bank_account_name": null,
"bank_account_number": null,
"bank_code": null,
"payout_active": false,
"stripe_account_id": null,
"funding_source_customer_id": "test_cus_10",
"balance": "$0",
"balance_value": 0,
"total_amount_withdrawn_lifetime": "$0",
"total_amount_withdrawn_today": "$0",
"last_withdrawn_amount": "$0",
"last_withdrawn_date": null,
"can_withraw": false,
"card_detail": {
"data": null
},
"transactions": [
],
"marketplace_subscription": null,
"plaqad_iq_subscription": {
"subscription_id": null,
"plan_id": null,
"end_date": null,
"plan_name": null,
"plan_data": null
},
"marketplace_subscription_count": 0,
"plaqad_iq_subscription_count": 0
}
}
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/wallets/301da472-351e-4e53-baad-fa109397109e" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id
GET /api/v1/wallets/301da472-351e-4e53-baad-fa109397109e
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/wallets/ok-ed-we" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: shavonda_gislason@satterfieldharber.io" \
-H "Authorization: ANkM_CsWUm4dvvi1bMpB" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id
GET /api/v1/wallets/ok-ed-we
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Getting a business's wallet
Request
curl -g "http://localhost:3000/api/v1/wallets/9bd166e1-2f0a-499c-b6b9-f0a402fa37c6" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: ramiro@medhurst.com" \
-H "Authorization: Cv_SFqfhZTzEQW_ZK6Hg" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id
GET /api/v1/wallets/9bd166e1-2f0a-499c-b6b9-f0a402fa37c6
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Getting a professional's wallet
Request
curl -g "http://localhost:3000/api/v1/wallets/9979adef-ef26-4335-8fda-9fa3b05301ea" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: annie.witting@okunevaschultz.io" \
-H "Authorization: 1-L6zaXLkr5MBtPEDwdx" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id
GET /api/v1/wallets/9979adef-ef26-4335-8fda-9fa3b05301ea
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"data": {
"errors": {
"detail": "You are not authorized to perform this action."
}
}
}
Wallets - Get Transactions
Getting a business's transactions
Request
curl -g "http://localhost:3000/api/v1/wallets/eec6a522-f44e-4b8b-aa10-d78383a9491e/transactions" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: bernita@brekke.name" \
-H "Authorization: 8-vbpZsWuQqiskzeepMp" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id/transactions
GET /api/v1/wallets/eec6a522-f44e-4b8b-aa10-d78383a9491e/transactions
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| start_date | Created_at start date |
| end_date | created_at end_date |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "aa8abde6-d418-4e02-9d71-94cc64d2ebe1",
"type": "transaction",
"attributes": {
"id": "aa8abde6-d418-4e02-9d71-94cc64d2ebe1",
"currency": "USD",
"transaction_type": "debit",
"category": "subscription",
"payment_method": "card",
"status": "pending",
"payment_reference_code": "test_su_3",
"wallet_id": null,
"customer_id": "b8076937-1383-43aa-aa09-1edfd805ea74",
"customer_type": "Business",
"job_id": null,
"amount": "-$29",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
},
{
"id": "29109bac-c8f4-4c13-996e-975d328a53de",
"type": "transaction",
"attributes": {
"id": "29109bac-c8f4-4c13-996e-975d328a53de",
"currency": "NGN",
"transaction_type": "credit",
"category": "topup",
"payment_method": "card",
"status": null,
"payment_reference_code": null,
"wallet_id": null,
"customer_id": "b8076937-1383-43aa-aa09-1edfd805ea74",
"customer_type": "Business",
"job_id": null,
"amount": "₦50,000",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
}
]
}
Getting a transactions without end_date
Request
curl -g "http://localhost:3000/api/v1/wallets/cf1aa411-d636-4329-a619-8e1ad455fc59/transactions?start_date=2021-06-01+00%3A00%3A00+UTC" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: charleen_rath@hills.com" \
-H "Authorization: 6Q4XEVSjgTXgyStdWF-9" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id/transactions
GET /api/v1/wallets/cf1aa411-d636-4329-a619-8e1ad455fc59/transactions?start_date=2021-06-01+00%3A00%3A00+UTC
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-01 00:00:00 UTC
| Name | Description |
|---|---|
| start_date | Created_at start date |
| end_date | created_at end_date |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "bdbe8f5d-8c2a-4d1e-a1b1-37d4d16e905d",
"type": "transaction",
"attributes": {
"id": "bdbe8f5d-8c2a-4d1e-a1b1-37d4d16e905d",
"currency": "NGN",
"transaction_type": "credit",
"category": "topup",
"payment_method": "card",
"status": null,
"payment_reference_code": null,
"wallet_id": null,
"customer_id": "387a6857-d696-4b81-a75e-bccd7fa24f58",
"customer_type": "Business",
"job_id": null,
"amount": "₦50,000",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
},
{
"id": "97c18dcd-f92e-4901-93a0-7dfc50301ef1",
"type": "transaction",
"attributes": {
"id": "97c18dcd-f92e-4901-93a0-7dfc50301ef1",
"currency": "USD",
"transaction_type": "debit",
"category": "subscription",
"payment_method": "card",
"status": "pending",
"payment_reference_code": "test_su_7",
"wallet_id": null,
"customer_id": "387a6857-d696-4b81-a75e-bccd7fa24f58",
"customer_type": "Business",
"job_id": null,
"amount": "-$29",
"created_at": "June 09, 2021 07:59",
"reference": {
}
}
}
]
}
Getting a transactions without end_date
Request
curl -g "http://localhost:3000/api/v1/wallets/4408f139-210c-4aaa-ba36-b17f61bb3ecb/transactions?start_date=2021-06-01+00%3A00%3A00+UTC&end_date=2021-06-09+07%3A59%3A43+UTC" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: anton@jacobshuel.co" \
-H "Authorization: LGg2MZqZKeXWF9uZAhcx" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id/transactions
GET /api/v1/wallets/4408f139-210c-4aaa-ba36-b17f61bb3ecb/transactions?start_date=2021-06-01+00%3A00%3A00+UTC&end_date=2021-06-09+07%3A59%3A43+UTC
Accept: application/json
Content-Type: application/json
Parameters
start_date: 2021-06-01 00:00:00 UTC
end_date: 2021-06-09 07:59:43 UTC
| Name | Description |
|---|---|
| start_date | Created_at start date |
| end_date | created_at end_date |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
]
}
Without Authentication
Request
curl -g "http://localhost:3000/api/v1/wallets/cfa791de-fbbb-4572-b244-355c0f17a1ff/transactions" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/wallets/:id/transactions
GET /api/v1/wallets/cfa791de-fbbb-4572-b244-355c0f17a1ff/transactions
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| start_date | Created_at start date |
| end_date | created_at end_date |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Web Notifications - Get All
Getting a list of user's notifications
Request
curl -g "http://localhost:3000/api/v1/web_notifications" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: manual.rohan@emard.co" \
-H "Authorization: 5WfGmNnSFj-xjBz3Rf1A" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/web_notifications
GET /api/v1/web_notifications
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "10cdcc25-8bc6-4699-92d5-9a024361775c",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Negotiation",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "f6f03c5c-1753-4bae-a84c-fb8d5cf94112",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Campaign",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "5132aa1e-f339-4b62-93ae-942fd83cb0c3",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Registration",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "51d3c418-bd0d-4255-9109-b74933db7541",
"type": "web_notification",
"attributes": {
"title": "Subscription Update 🎉🎉🎉",
"content": "YAY! Your subscription to the PlaqadM Starter monthly plan was successful!",
"read": false,
"category": "Payments",
"record_id": "payments",
"hyperlink_id": "Click here to continue",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
},
"unread_count": 4
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/web_notifications" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/web_notifications
GET /api/v1/web_notifications
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Web Notifications - Update
Successful with valid params
Request
curl "http://localhost:3000/api/v1/web_notifications/3f3d9e92-cf7f-47ea-8893-3d69ada43fef" -d '{"web_notification":{"read":true}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lacy@koelpinweber.name" \
-H "Authorization: Ey6osvzSe77Qcj4cQoyG" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/web_notifications/:id
PATCH /api/v1/web_notifications/3f3d9e92-cf7f-47ea-8893-3d69ada43fef
Accept: application/json
Content-Type: application/json
Parameters
{"web_notification":{"read":true}}
| Name | Description |
|---|---|
| web_notification[read] required | Boolean - Mark notification as 'read' |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"result": {
"data": [
{
"id": "3f3d9e92-cf7f-47ea-8893-3d69ada43fef",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": true,
"category": "Registration",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
}
]
},
"unread_count": 1
}
Web Notifications - Filter
Search without filters returns all records
Request
curl -g "http://localhost:3000/api/v1/web_notifications" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: caey.gorczany@oconnell.co" \
-H "Authorization: zxY8UJgSTUUEG5aQxocu" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/web_notifications
GET /api/v1/web_notifications
Accept: application/json
Content-Type: application/json
Parameters
{}:
| Name | Description |
|---|---|
| categories | Filter by Notification categories |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "80522e0f-4d23-47da-b1ab-bfdada489a51",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Negotiation",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "a3d202b5-d6f5-4365-9665-702b2aad39fd",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Negotiation",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "1da24d92-ab09-4e1d-a2fc-f887b7446897",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Campaign",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "8d8efa10-9215-4d77-b26c-be179f895e39",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Registration",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "ad82abc3-31e1-4be7-9f93-e8e8ac874af8",
"type": "web_notification",
"attributes": {
"title": "Subscription Update 🎉🎉🎉",
"content": "YAY! Your subscription to the PlaqadM Starter monthly plan was successful!",
"read": false,
"category": "Payments",
"record_id": "payments",
"hyperlink_id": "Click here to continue",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 5
}
},
"unread_count": 5
}
Filter by 'Campaign' Notification category
Request
curl -g "http://localhost:3000/api/v1/web_notifications?categories=Campaign" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: alvin@moriette.org" \
-H "Authorization: Fb2Xo18QpPgh-u39S3e3" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/web_notifications
GET /api/v1/web_notifications?categories=Campaign
Accept: application/json
Content-Type: application/json
Parameters
categories: Campaign
| Name | Description |
|---|---|
| categories | Filter by Notification categories |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "66dbf389-c3d6-43d2-ad9a-9005da61948b",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Campaign",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 1
}
},
"unread_count": 1
}
Filter by 'Negotiation' Notification category
Request
curl -g "http://localhost:3000/api/v1/web_notifications?categories=Negotiation" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tracee@lind.name" \
-H "Authorization: gGAdk7vSbQyBogzhPvD4" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/web_notifications
GET /api/v1/web_notifications?categories=Negotiation
Accept: application/json
Content-Type: application/json
Parameters
categories: Negotiation
| Name | Description |
|---|---|
| categories | Filter by Notification categories |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "b5c4a7e0-e014-4e2f-acce-f171d8da2248",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Negotiation",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "af6db395-2527-4eea-a31f-f7c7df2f7baf",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Negotiation",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 2
}
},
"unread_count": 2
}
Filter by multiple Notification categories
Request
curl -g "http://localhost:3000/api/v1/web_notifications?categories=Campaign%2CNegotiation%2CRegistration" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: rodrick.bahringer@bechtelar.com" \
-H "Authorization: 7GExDeL-KV3NEmzvTVs8" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/web_notifications
GET /api/v1/web_notifications?categories=Campaign%2CNegotiation%2CRegistration
Accept: application/json
Content-Type: application/json
Parameters
categories: Campaign,Negotiation,Registration
| Name | Description |
|---|---|
| categories | Filter by Notification categories |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"results": {
"data": [
{
"id": "bd10aa4a-7c8d-4152-a5bc-be96076342a5",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Negotiation",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "33c3002f-db74-4688-8c7c-3d66010d0dc5",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Negotiation",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "2b41dde3-8592-4bcd-98c3-22ca79aaf2bc",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Campaign",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
},
{
"id": "f7c9f988-c1c8-446e-975f-c1199be73e29",
"type": "web_notification",
"attributes": {
"title": "New Notif",
"content": "Congratulations on successfully posting your campaign",
"read": false,
"category": "Registration",
"record_id": "o9u9wu9u-9u00wkjojuw0w",
"hyperlink_id": "uy79ww-ios8y8sihhwhw",
"formatted_dates": {
"created_date": "June 09, 2021 07:59"
}
}
}
]
},
"meta": {
"pagination": {
"current_page": 1,
"prev_page": null,
"next_page": null,
"total_pages": 1,
"total_count": 4
}
},
"unread_count": 4
}
Businesses - Create Accounts
Successfully creating a business
Request
curl "http://localhost:3000/api/v1/businesses" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[name]"
Imergent Biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[website]"
www.imerge.biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[business_logo]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: robbi.hyatt@barrows.com" \
-H "Authorization: 1YjPgrmUcXzcAGPNfQzm" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses
POST /api/v1/businesses
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[name]"
Imergent Biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[website]"
www.imerge.biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[business_logo]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| business[name] required | Name of business |
| business[website] | Business website |
| business[description] | Information about the business |
| business[phone_number] | Business contact number |
| business[address] | Address of the business |
| business[industry] | Industry of the business |
| business[company_size] | Size of company |
| business[business_type] | Type of business |
| business[business_logo] | Image/logo business |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "a46b040f-5f62-497a-9170-9e9916b93011",
"type": "authenticated_user",
"attributes": {
"fullname": "Sanora Franecki",
"username": "sanora-franecki-a46b040f-5f62-497a-9170-9e9916b93011",
"email": "robbi.hyatt@barrows.com",
"firstname": "Sanora",
"lastname": "Franecki",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "1YjPgrmUcXzcAGPNfQzm",
"currency": "USD",
"country_code": null,
"role": "admin",
"wallet_id": "93cc7eb5-f6ae-43f5-b71e-79f81b9e9642",
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": "f1a228a7-9c2a-4b58-8df9-733b39e01e70",
"marketplace_plan_id": "39dd0a36-34c6-4d89-ab39-2ffc1cca20b8",
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": {
"data": {
"id": "d01260b0-0e98-45d8-b5a1-6f370ca905ad",
"type": "business",
"attributes": {
"name": "Imergent Biz",
"description": null,
"phone_number": null,
"website": "www.imerge.biz",
"address": null,
"industry": null,
"company_size": null,
"business_type": null,
"status": "active",
"logo_url": "/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWxrWVRWbE1tVm1aUzFpTkRSbUxUUm1NRGN0WVRJNVpTMDVaakUzTmpjNVpXRXpOVElHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--264b4bf009d3a968051032ec8ef7c218474b5849/fruits.jpeg",
"avg_ratings": 0.0,
"has_active_marketplace_subscription": true,
"marketplace_subscription_id": "f1a228a7-9c2a-4b58-8df9-733b39e01e70",
"has_active_plaqad_iq_subscription": false,
"plaqad_iq_subscription_id": null,
"can_create_campaign": true,
"can_accept_proposal": true,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"profile_image_url": ""
}
}
}
With no name
Request
curl "http://localhost:3000/api/v1/businesses" -d '{"business":{"name":"","website":"www.imergent.biz"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: darrel_mante@roobstark.net" \
-H "Authorization: VVHA4wwz6azxRty8xmKh" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses
POST /api/v1/businesses
Accept: application/json
Content-Type: application/json
Parameters
{"business":{"name":"","website":"www.imergent.biz"}}
| Name | Description |
|---|---|
| business[name] required | Name of business |
| business[website] | Business website |
| business[description] | Information about the business |
| business[phone_number] | Business contact number |
| business[address] | Address of the business |
| business[industry] | Industry of the business |
| business[company_size] | Size of company |
| business[business_type] | Type of business |
| business[business_logo] | Image/logo business |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "business",
"errors": [
{
"source": {
"pointer": "/data/attributes/name"
},
"detail": "Name can't be blank",
"title": "can't be blank"
}
]
}
Without authentication
Request
curl "http://localhost:3000/api/v1/businesses" -d '{"business":{"name":"Igobi Farms","website":"www.igobi.biz"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses
POST /api/v1/businesses
Accept: application/json
Content-Type: application/json
Parameters
{"business":{"name":"Igobi Farms","website":"www.igobi.biz"}}
| Name | Description |
|---|---|
| business[name] required | Name of business |
| business[website] | Business website |
| business[description] | Information about the business |
| business[phone_number] | Business contact number |
| business[address] | Address of the business |
| business[industry] | Industry of the business |
| business[company_size] | Size of company |
| business[business_type] | Type of business |
| business[business_logo] | Image/logo business |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Businesses - Get All
Getting a list of businesses
Request
curl -g "http://localhost:3000/api/v1/businesses" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: joesph.harber@moen.io" \
-H "Authorization: 6e59PpEYC2PrvArdtxAv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses
GET /api/v1/businesses
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "5ce49b82-5171-4030-aeb0-141acf3df0c1",
"type": "business",
"attributes": {
"name": "Hansen-Kemmer",
"description": "Consequatur nulla rerum. Nihil ipsum est. Aspernatur sint sint.",
"phone_number": null,
"website": "nader.net",
"address": null,
"industry": null,
"company_size": null,
"business_type": null,
"status": "active",
"logo_url": null,
"avg_ratings": 0.0,
"has_active_marketplace_subscription": true,
"marketplace_subscription_id": "1c2d351f-8f2b-44d5-8add-7d54556bb40f",
"has_active_plaqad_iq_subscription": false,
"plaqad_iq_subscription_id": null,
"can_create_campaign": true,
"can_accept_proposal": true,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
},
{
"id": "5dcb27a1-5a90-4a65-a403-e8a25a7cfd79",
"type": "business",
"attributes": {
"name": "Pollich-Lesch",
"description": "Culpa nisi distinctio. In esse numquam. Molestiae ea fuga.",
"phone_number": null,
"website": "kunde.org",
"address": null,
"industry": null,
"company_size": null,
"business_type": null,
"status": "active",
"logo_url": null,
"avg_ratings": 0.0,
"has_active_marketplace_subscription": true,
"marketplace_subscription_id": "a286ebd0-2a33-4b6a-9e8a-de28404eb6c6",
"has_active_plaqad_iq_subscription": false,
"plaqad_iq_subscription_id": null,
"can_create_campaign": true,
"can_accept_proposal": true,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
},
{
"id": "2e2346e3-807e-4caf-824b-70da120518c4",
"type": "business",
"attributes": {
"name": "Franecki LLC",
"description": "Qui excepturi labore. Consectetur sit qui. Voluptas dolor quod.",
"phone_number": null,
"website": "mrazcruickshank.co",
"address": null,
"industry": null,
"company_size": null,
"business_type": null,
"status": "active",
"logo_url": null,
"avg_ratings": 0.0,
"has_active_marketplace_subscription": true,
"marketplace_subscription_id": "970e16df-cc8a-4500-acc0-1eef13d6dc00",
"has_active_plaqad_iq_subscription": false,
"plaqad_iq_subscription_id": null,
"can_create_campaign": true,
"can_accept_proposal": true,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
]
}
Without authentication
Request
curl -g "http://localhost:3000/api/v1/businesses" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses
GET /api/v1/businesses
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Businesses - Get One
Getting a specific business
Request
curl -g "http://localhost:3000/api/v1/businesses/1051473c-38fc-4ca6-afc6-7dbe3391b912" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: lois.flatley@bailey.info" \
-H "Authorization: 9Bsw-DPqgUQvfZQG6Kcv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:id
GET /api/v1/businesses/1051473c-38fc-4ca6-afc6-7dbe3391b912
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "1051473c-38fc-4ca6-afc6-7dbe3391b912",
"type": "business",
"attributes": {
"name": "Koelpin-Pfannerstill",
"description": "Aliquam facere sed. Quia dicta incidunt. Unde consequatur consequuntur.",
"phone_number": null,
"website": "rohan.net",
"address": null,
"industry": null,
"company_size": null,
"business_type": null,
"status": "active",
"logo_url": null,
"avg_ratings": 0.0,
"has_active_marketplace_subscription": true,
"marketplace_subscription_id": "1dad3c17-73df-478e-9ab0-ab00d67a598d",
"has_active_plaqad_iq_subscription": false,
"plaqad_iq_subscription_id": null,
"can_create_campaign": true,
"can_accept_proposal": true,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
}
When id is not availabe
Request
curl -g "http://localhost:3000/api/v1/businesses/a" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: allena_lemke@bashirianhickle.biz" \
-H "Authorization: o5wVyquyt4ae79G74e7y" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:id
GET /api/v1/businesses/a
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Businesses - Get Teams - Members Only
Getting a specific business
Request
curl -g "http://localhost:3000/api/v1/businesses/73d64aa8-77ae-4544-92aa-e9f1bd509dbe/teams" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jesusita@raynor.info" \
-H "Authorization: vkGQgcnLovmZK3hyzyyy" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/teams
GET /api/v1/businesses/73d64aa8-77ae-4544-92aa-e9f1bd509dbe/teams
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "c35a3361-3869-489b-8164-dc30d3ea97a6",
"type": "team",
"attributes": {
"fullname": "Josef Maggio",
"email": "alfred_brown@corkery.com",
"invitation_created_at": null,
"invitation_sent_at": null,
"invitation_accepted_at": null,
"invitation_token": null,
"role": "member",
"invited_by": null,
"invitation_accepted_at_in_words": null
}
},
{
"id": "67fc24f4-4a4a-472c-8593-b098015bf17a",
"type": "team",
"attributes": {
"fullname": "Jc Veum",
"email": "rogelio@romaguera.info",
"invitation_created_at": null,
"invitation_sent_at": null,
"invitation_accepted_at": null,
"invitation_token": null,
"role": "member",
"invited_by": null,
"invitation_accepted_at_in_words": null
}
},
{
"id": "433203bc-507e-4769-98fc-6d7fd8ce89e9",
"type": "team",
"attributes": {
"fullname": "Guadalupe Thiel",
"email": "rachele@cummingsabbott.co",
"invitation_created_at": null,
"invitation_sent_at": null,
"invitation_accepted_at": null,
"invitation_token": null,
"role": "member",
"invited_by": null,
"invitation_accepted_at_in_words": null
}
}
]
}
Getting another user's business team
Request
curl -g "http://localhost:3000/api/v1/businesses/0c555ed4-7743-4230-a5ef-deb5c2a10ff2/teams" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jennette_cronin@pricegoodwin.com" \
-H "Authorization: WPTrPwEVgzsbqVjyeiZr" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/teams
GET /api/v1/businesses/0c555ed4-7743-4230-a5ef-deb5c2a10ff2/teams
Accept: application/json
Content-Type: application/json
Parameters
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Businesses - Get Teams - Admin Only
Getting a specific business
Request
curl -g "http://localhost:3000/api/v1/businesses/1814d7d3-6172-4d4e-b24f-7038a4d4f086/teams?role=admin" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: josue@spinkaokeefe.co" \
-H "Authorization: uk_m17gK6zNKyyt7dToH" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/businesses/:business_id/teams
GET /api/v1/businesses/1814d7d3-6172-4d4e-b24f-7038a4d4f086/teams?role=admin
Accept: application/json
Content-Type: application/json
Parameters
role: admin
| Name | Description |
|---|---|
| role | role |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": [
{
"id": "0a7e6440-9bd5-4f0b-8ea1-32ecc1aa9357",
"type": "team",
"attributes": {
"fullname": "Dee Roberts",
"email": "josue@spinkaokeefe.co",
"invitation_created_at": null,
"invitation_sent_at": null,
"invitation_accepted_at": null,
"invitation_token": null,
"role": "admin",
"invited_by": null,
"invitation_accepted_at_in_words": null
}
},
{
"id": "bb0d786e-64a1-4b68-a526-9c184a6e0866",
"type": "team",
"attributes": {
"fullname": "Douglass Dibbert",
"email": "ahmad@hagenesboyer.co",
"invitation_created_at": null,
"invitation_sent_at": null,
"invitation_accepted_at": null,
"invitation_token": null,
"role": "admin",
"invited_by": null,
"invitation_accepted_at_in_words": null
}
},
{
"id": "458c933e-b9e7-4b4f-b879-341dd68a6dc8",
"type": "team",
"attributes": {
"fullname": "Antone Rau",
"email": "breann@fritschheaney.net",
"invitation_created_at": null,
"invitation_sent_at": null,
"invitation_accepted_at": null,
"invitation_token": null,
"role": "admin",
"invited_by": null,
"invitation_accepted_at_in_words": null
}
}
]
}
Businesses - Teams - Make Admin
Giving a user admin access to a business
Request
curl "http://localhost:3000/api/v1/businesses/7ba43f2d-0691-4703-b7b6-7ca1792b13b2/make_admin" -d '{"business":{"user_id":"57e10284-fd73-4d5d-9e64-781595d836e0"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: dorris@boganrutherford.co" \
-H "Authorization: p4b6Lt4UmraoZn_VZ4ud" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/make_admin
PATCH /api/v1/businesses/7ba43f2d-0691-4703-b7b6-7ca1792b13b2/make_admin
Accept: application/json
Content-Type: application/json
Parameters
{"business":{"user_id":"57e10284-fd73-4d5d-9e64-781595d836e0"}}
| Name | Description |
|---|---|
| business[user_id] | Id of the user to be removed |
Response
Content-Type: application/json
200 OK
Businesses - Teams - Remove User
Remove a user access to a business
Request
curl "http://localhost:3000/api/v1/businesses/e03f59ee-fd08-4350-b05f-e2e5b79d43bb/remove_user" -d '{"business":{"user_id":"63edca90-0cf1-4251-bf7d-ef2b8eacb216"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: joe_koelpin@lesch.co" \
-H "Authorization: Am_ZHM2P5gfzdwpxAdAy" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/remove_user
PATCH /api/v1/businesses/e03f59ee-fd08-4350-b05f-e2e5b79d43bb/remove_user
Accept: application/json
Content-Type: application/json
Parameters
{"business":{"user_id":"63edca90-0cf1-4251-bf7d-ef2b8eacb216"}}
| Name | Description |
|---|---|
| business[user_id] | Id of the user to be removed |
Response
Content-Type: application/json
200 OK
With an invalid member
Request
curl "http://localhost:3000/api/v1/businesses/be4082e5-4538-40bc-8372-8023bb288e38/remove_user" -d '{"business":{"user_id":"7867"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: peggie@hartmann.co" \
-H "Authorization: G1sv39NzzWL994NA9eND" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:business_id/remove_user
PATCH /api/v1/businesses/be4082e5-4538-40bc-8372-8023bb288e38/remove_user
Accept: application/json
Content-Type: application/json
Parameters
{"business":{"user_id":"7867"}}
| Name | Description |
|---|---|
| business[user_id] | Id of the user to be removed |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Businesses - Update
Updating a business
Request
curl "http://localhost:3000/api/v1/businesses/c425a472-5a6d-48ba-afe5-ea69bb21214a" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[name]"
Imergent Biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[website]"
www.imerge.biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[business_logo]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: roscoe_hoeger@watsica.net" \
-H "Authorization: Nz3_1zWTrcGeu_P5by4Z" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:id
PATCH /api/v1/businesses/c425a472-5a6d-48ba-afe5-ea69bb21214a
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[name]"
Imergent Biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[website]"
www.imerge.biz
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="business[business_logo]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| business[name] required | Name of business |
| business[website] | Business website |
| business[description] | Information about the business |
| business[phone_number] | Business contact number |
| business[address] | Address of the business |
| business[industry] | Industry of the business |
| business[company_size] | Size of company |
| business[business_type] | Type of business |
| business[business_logo] | Image/logo business |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "cb80c900-13a5-45fe-917a-d67eed32cbc8",
"type": "authenticated_user",
"attributes": {
"fullname": "Deangelo Goodwin",
"username": "deangelo-goodwin-cb80c900-13a5-45fe-917a-d67eed32cbc8",
"email": "roscoe_hoeger@watsica.net",
"firstname": "Deangelo",
"lastname": "Goodwin",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "Nz3_1zWTrcGeu_P5by4Z",
"currency": "USD",
"country_code": null,
"role": "admin",
"wallet_id": "b8e7c8bc-d78e-44cb-aac3-108cd734fd35",
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": "27fe3bb7-73aa-4ab3-8156-83bb7cc56287",
"marketplace_plan_id": "c70f23fd-0983-48b6-a768-6449fa865143",
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": {
"data": {
"id": "c425a472-5a6d-48ba-afe5-ea69bb21214a",
"type": "business",
"attributes": {
"name": "Imergent Biz",
"description": "Voluptas velit dolorem. Maiores iusto distinctio. Commodi numquam omnis.",
"phone_number": null,
"website": "www.imerge.biz",
"address": null,
"industry": null,
"company_size": null,
"business_type": null,
"status": "active",
"logo_url": "/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6TURBMk16YzNaUzB4WkdObUxUUmpOVEF0WWpBd09DMDNNRGN5T0ROa016QXpNakVHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--e8770aae6b6c8971279248cb57d9fb88cc87b578/fruits.jpeg",
"avg_ratings": 0.0,
"has_active_marketplace_subscription": true,
"marketplace_subscription_id": "27fe3bb7-73aa-4ab3-8156-83bb7cc56287",
"has_active_plaqad_iq_subscription": false,
"plaqad_iq_subscription_id": null,
"can_create_campaign": true,
"can_accept_proposal": true,
"can_create_hashtag_or_keyword": false,
"can_create_social_account": false
}
}
},
"profile_image_url": ""
}
}
}
Updating another user's business
Request
curl "http://localhost:3000/api/v1/businesses/e67a36c8-0d8c-4a6b-91c7-6e564ca23b96" -d '{"business":{"name":"Igobi Farms"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: sirena_hammes@walsh.name" \
-H "Authorization: xKx-gqANeeh4uzsWyUVz" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:id
PATCH /api/v1/businesses/e67a36c8-0d8c-4a6b-91c7-6e564ca23b96
Accept: application/json
Content-Type: application/json
Parameters
{"business":{"name":"Igobi Farms"}}
| Name | Description |
|---|---|
| business[name] required | Name of business |
| business[website] | Business website |
| business[description] | Information about the business |
| business[phone_number] | Business contact number |
| business[address] | Address of the business |
| business[industry] | Industry of the business |
| business[company_size] | Size of company |
| business[business_type] | Type of business |
| business[business_logo] | Image/logo business |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Without authentication
Request
curl "http://localhost:3000/api/v1/businesses/cfc3cad4-8d70-4bc7-9f1a-9cbe5aca8fd0" -d '{"business":{"name":"Igobi Farms"}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/businesses/:id
PATCH /api/v1/businesses/cfc3cad4-8d70-4bc7-9f1a-9cbe5aca8fd0
Accept: application/json
Content-Type: application/json
Parameters
{"business":{"name":"Igobi Farms"}}
| Name | Description |
|---|---|
| business[name] required | Name of business |
| business[website] | Business website |
| business[description] | Information about the business |
| business[phone_number] | Business contact number |
| business[address] | Address of the business |
| business[industry] | Industry of the business |
| business[company_size] | Size of company |
| business[business_type] | Type of business |
| business[business_logo] | Image/logo business |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Businesses - Invite Professionals
Successfully inviting a professional
Request
curl "http://localhost:3000/api/v1/businesses/d67a8801-9d25-4d2d-a87f-df88c90309e4/invite_professional" -d '{"invitation":{"professional_id":"c3c4b0f1-7bfe-42dd-9e3b-3d8860f8fd87","job_id":"a84c5f8b-86a3-4d07-89f3-e59238f029a9","message":"Please apply to this job. Hurry!"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: stephen@gusikowski.name" \
-H "Authorization: LTAQajk3ymsLs8-tjEvC" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/invite_professional
POST /api/v1/businesses/d67a8801-9d25-4d2d-a87f-df88c90309e4/invite_professional
Accept: application/json
Content-Type: application/json
Parameters
{"invitation":{"professional_id":"c3c4b0f1-7bfe-42dd-9e3b-3d8860f8fd87","job_id":"a84c5f8b-86a3-4d07-89f3-e59238f029a9","message":"Please apply to this job. Hurry!"}}
| Name | Description |
|---|---|
| invitation[professional_id] required | ID of professional |
| invitation[job_id] required | ID of job |
| invitation[message] required | Message to professional |
Response
Content-Type: application/json
200 OK
Without message
Request
curl "http://localhost:3000/api/v1/businesses/435efbec-09b9-4ada-b96e-365f5f455fd6/invite_professional" -d '{"invitation":{"professional_id":"90cf9f76-5803-42d0-aa51-078b7f8a7bff","job_id":"3dcb416e-a88a-4338-8adb-6e73520281b6"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: isiah_beer@lehner.io" \
-H "Authorization: ztUPggf9qrSWxSZ1fTKz" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/invite_professional
POST /api/v1/businesses/435efbec-09b9-4ada-b96e-365f5f455fd6/invite_professional
Accept: application/json
Content-Type: application/json
Parameters
{"invitation":{"professional_id":"90cf9f76-5803-42d0-aa51-078b7f8a7bff","job_id":"3dcb416e-a88a-4338-8adb-6e73520281b6"}}
| Name | Description |
|---|---|
| invitation[professional_id] required | ID of professional |
| invitation[job_id] required | ID of job |
| invitation[message] required | Message to professional |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "",
"type": "jobinvitation",
"errors": [
{
"source": {
"pointer": "/data/attributes/message"
},
"detail": "Message can't be blank",
"title": "can't be blank"
}
]
}
Professional trying to invite another professional
Request
curl "http://localhost:3000/api/v1/businesses/22698579-1db7-473c-9965-dcc4ab0c5df9/invite_professional" -d '{"invitation":{"professional_id":"e4fc094b-546e-4679-b485-e2fa5d7bfbcd","job_id":"61bd38df-d5cf-4645-8008-5df784fe37cf","message":"Please apply to this job. Hurry!"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: jannet@flatley.com" \
-H "Authorization: GqHkNuQ46-P-TTZLwami" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/invite_professional
POST /api/v1/businesses/22698579-1db7-473c-9965-dcc4ab0c5df9/invite_professional
Accept: application/json
Content-Type: application/json
Parameters
{"invitation":{"professional_id":"e4fc094b-546e-4679-b485-e2fa5d7bfbcd","job_id":"61bd38df-d5cf-4645-8008-5df784fe37cf","message":"Please apply to this job. Hurry!"}}
| Name | Description |
|---|---|
| invitation[professional_id] required | ID of professional |
| invitation[job_id] required | ID of job |
| invitation[message] required | Message to professional |
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Without authentication
Request
curl "http://localhost:3000/api/v1/businesses/3ee5cecf-c30d-404e-af7c-b5e612f569e9/invite_professional" -d '{"invitation":{"professional_id":"fd1bc04c-8a6d-4fa2-8190-c2b7eaaee223","job_id":"d18eac41-bce6-498f-9697-dac58be80a7c","message":"Please apply to this job. Hurry!"}}' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
POST /api/v1/businesses/:business_id/invite_professional
POST /api/v1/businesses/3ee5cecf-c30d-404e-af7c-b5e612f569e9/invite_professional
Accept: application/json
Content-Type: application/json
Parameters
{"invitation":{"professional_id":"fd1bc04c-8a6d-4fa2-8190-c2b7eaaee223","job_id":"d18eac41-bce6-498f-9697-dac58be80a7c","message":"Please apply to this job. Hurry!"}}
| Name | Description |
|---|---|
| invitation[professional_id] required | ID of professional |
| invitation[job_id] required | ID of job |
| invitation[message] required | Message to professional |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}
Users - Get One
Getting a specific user
Request
curl -g "http://localhost:3000/api/v1/users/3b647aa1-093d-4dbc-bc07-9e3d24d1398e" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: robbyn@balistreri.info" \
-H "Authorization: DyQewXzcVtCktAVDsiYv" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/:id
GET /api/v1/users/3b647aa1-093d-4dbc-bc07-9e3d24d1398e
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "3b647aa1-093d-4dbc-bc07-9e3d24d1398e",
"type": "authenticated_user",
"attributes": {
"fullname": "Mariana Crooks",
"username": "mariana-crooks-3b647aa1-093d-4dbc-bc07-9e3d24d1398e",
"email": "robbyn@balistreri.info",
"firstname": "Mariana",
"lastname": "Crooks",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "DyQewXzcVtCktAVDsiYv",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": null,
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
{
"youtube": {
"data": {
"provider_identifier": "UcGQ00Rvc",
"profile_image": "http://pbgyu.com/profile_img",
"username": "UcGQ00Rvc",
"name": "Odinma Umah",
"bio": "",
"followers_count": 9000,
"total_posts_count": 3,
"avg_engagement_rate": null,
"post_timeline": null
}
}
}
],
"professional": null,
"business": null,
"profile_image_url": "http://pbgyu.com/profile_img"
}
}
}
With invalid id
Request
curl -g "http://localhost:3000/api/v1/users/a" -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: tracee.okon@hamill.biz" \
-H "Authorization: E_LpeAerLBniuh4C9mvq" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
GET /api/v1/users/:id
GET /api/v1/users/a
Accept: application/json
Content-Type: application/json
Parameters
{}:
None known.
Response
Content-Type: application/json; charset=utf-8
404 Not Found
{
"data": {
"errors": {
"detail": "Not found. Record does not exist."
}
}
}
Users - Update
Successfully updating a user
Request
curl "http://localhost:3000/api/v1/users/842536e3-7de4-438c-8e7a-884214303a01" -d '------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="user[firstname]"
IjeomaKing
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="user[profile_image]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
-H "X-User-Email: bart.ferry@corwin.net" \
-H "Authorization: pLoYSKXwTJTsZ9yoz3NL" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/:id
PATCH /api/v1/users/842536e3-7de4-438c-8e7a-884214303a01
Accept: application/json
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Parameters
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="user[firstname]"
IjeomaKing
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="user[profile_image]"; filename="fruits.jpeg"
Content-Type:
Content-Length: 88282
[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--
| Name | Description |
|---|---|
| user[fullname] | Name of user |
| user[firstname] | User's firstname |
| user[lastname] | User's lastname |
| user[email] | Email of user |
| user[bio] | User's profile description |
| user[location] | User's location |
| user[profile_image] | Image/file user |
Response
Content-Type: application/json; charset=utf-8
200 OK
{
"data": {
"id": "842536e3-7de4-438c-8e7a-884214303a01",
"type": "authenticated_user",
"attributes": {
"fullname": "IjeomaKing D'Amore",
"username": "roma-d'amore-842536e3-7de4-438c-8e7a-884214303a01",
"email": "bart.ferry@corwin.net",
"firstname": "IjeomaKing",
"lastname": "D'Amore",
"bio": null,
"location": null,
"email_status": "confirmed",
"authentication_token": "pLoYSKXwTJTsZ9yoz3NL",
"currency": "USD",
"country_code": null,
"role": null,
"wallet_id": null,
"wallet_balance": {
"formated_dollar_value": "$0",
"formated_naira_value": "₦0",
"value": 0
},
"marketplace_subscription_id": null,
"marketplace_plan_id": null,
"plaqad_iq_subscription_id": null,
"plaqad_iq_plan_id": null,
"providers": [
],
"professional": null,
"business": null,
"profile_image_url": "/rails/active_storage/blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJaWt6WXpNeVpXVXlNUzAxWkRoaUxUUXdPRGt0T0RKaFlTMDJOREpoWmpJek5HSTRNRFFHT2daRlZBPT0iLCJleHAiOm51bGwsInB1ciI6ImJsb2JfaWQifX0=--d6c1e58d7055fe02969e287587e55740ced76db6/fruits.jpeg"
}
}
}
With invalid email
Request
curl "http://localhost:3000/api/v1/users/%3Aid" -d '{"user":{"email":""}}' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-User-Email: carrol@murphy.org" \
-H "Authorization: VtZfw7_U3yUSGinuUuJH" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/:id
PATCH /api/v1/users/%3Aid
Accept: application/json
Content-Type: application/json
Parameters
{"user":{"email":""}}
| Name | Description |
|---|---|
| user[fullname] | Name of user |
| user[firstname] | User's firstname |
| user[lastname] | User's lastname |
| user[email] | Email of user |
| user[bio] | User's profile description |
| user[location] | User's location |
| user[profile_image] | Image/file user |
Response
Content-Type: application/json; charset=utf-8
422 Unprocessable Entity
{
"id": "30450c8f-a5a4-4ce9-915c-5953c74dfcaf",
"type": "user",
"errors": [
{
"source": {
"pointer": "/data/attributes/email"
},
"detail": "Email can't be blank",
"title": "can't be blank"
}
]
}
Without authentication
Request
curl "http://localhost:3000/api/v1/users/%3Aid" -d '' -X PATCH \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Host: example.org" \
-H "Cookie: "
Endpoint
PATCH /api/v1/users/:id
PATCH /api/v1/users/%3Aid
Accept: application/json
Content-Type: application/json
Parameters
| Name | Description |
|---|---|
| user[fullname] | Name of user |
| user[firstname] | User's firstname |
| user[lastname] | User's lastname |
| user[email] | Email of user |
| user[bio] | User's profile description |
| user[location] | User's location |
| user[profile_image] | Image/file user |
Response
Content-Type: application/json; charset=utf-8
401 Unauthorized
{
"error": "You need to sign in or sign up before continuing."
}